er.rest.format

Class ERXRestFormat

java.lang.Object

er.rest.format.ERXRestFormat

public class ERXRestFormat
extends Object

The ERXRestFormat class encapsulates the details of message formatting. As such it encapsulates the request parser, response formatter, format name and response mime type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERXRestFormat.Delegate An ERXRestFormat.Delegate is one component of an ERXRestFormat and is used to customize an ERXRequestNode after parsing in the context of reading a request or before writing in the context of a response generation.
static class	ERXRestFormat.NoOpDelegate

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_PLIST_KEY
static String	EMBER_KEY
static String	FORM_KEY
static String	HTML_KEY
static String	JS_KEY
static String	JSON_KEY
static String	PLIST_KEY
static String	RAILS_KEY
static String	SPROUTCORE_KEY
static String	XML_KEY

Constructor Summary

Constructors

Constructor and Description
ERXRestFormat(String name, IERXRestParser parser, IERXRestWriter writer, ERXRestFormat.Delegate delegate) Constructs a new ERXRestFormat.

Method Summary

Modifier and Type	Method and Description
static ERXRestFormat	bplist() Returns the registered plist format.
ERXRestFormat.Delegate	delegate()
static ERXRestFormat	form() Returns the registered html form format.
static ERXRestFormat	formatNamed(String name)
static boolean	hasFormatNamed(String name) Returns true if there is a format registered with the given name.
static ERXRestFormat	html() Returns the registered html format.
static ERXRestFormat	json() Returns the registered json format.
String	name() Returns the name of this format.
ERXRestRequestNode	parse(IERXRestRequest request, ERXRestContext context) Returns a parsed ERXRestRequestNode using this format's parser.
ERXRestRequestNode	parse(String str) Returns a parsed ERXRestRequestNode using this format's parser.
ERXRestRequestNode	parse(String str, ERXRestContext context) Returns a parsed ERXRestRequestNode using this format's parser.
IERXRestParser	parser()
static ERXRestFormat	plist() Returns the registered plist format.
static ERXRestFormat	registerFormatNamed(ERXRestFormat format, String name)
static ERXRestFormat	registerFormatNamed(IERXRestParser parser, IERXRestWriter writer, ERXRestFormat.Delegate delegate, String... names)
String	toString()
String	toString(com.webobjects.eocontrol.EOClassDescription classDescription, List<?> list, ERXKeyFilter filter, ERXRestContext context) Returns the formatted version of the given list.
String	toString(Object obj) Returns the formatted version of the given object using a recursive "All" filter and the default rest delegate.
String	toString(Object obj, ERXKeyFilter filter) Returns the formatted version of the given object using a recursive "All" filter.
String	toString(Object obj, ERXKeyFilter filter, ERXRestContext context) Returns the formatted version of the given object.
String	toString(Object obj, ERXRestContext context) Returns the formatted version of the given object using a recursive "All" filter.
IERXRestWriter	writer()
static ERXRestFormat	xml() Returns the registered xml format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HTML_KEY

public static final String HTML_KEY

See Also:

Constant Field Values

JSON_KEY

public static final String JSON_KEY

See Also:

Constant Field Values

JS_KEY

public static final String JS_KEY

See Also:

Constant Field Values

RAILS_KEY

public static final String RAILS_KEY

See Also:

Constant Field Values

PLIST_KEY

public static final String PLIST_KEY

See Also:

Constant Field Values

SPROUTCORE_KEY

public static final String SPROUTCORE_KEY

See Also:

Constant Field Values

XML_KEY

public static final String XML_KEY

See Also:

Constant Field Values

FORM_KEY

public static final String FORM_KEY

See Also:

Constant Field Values

BINARY_PLIST_KEY

public static final String BINARY_PLIST_KEY

See Also:

Constant Field Values

EMBER_KEY

public static final String EMBER_KEY

See Also:

Constant Field Values

Constructor Detail

ERXRestFormat

public ERXRestFormat(String name,
                     IERXRestParser parser,
                     IERXRestWriter writer,
                     ERXRestFormat.Delegate delegate)

Constructs a new ERXRestFormat.

Parameters:

name - the name of the format

parser - the parser

writer - the writer

delegate - the delegate to use while parsing and writing

Method Detail

form

public static ERXRestFormat form()

Returns the registered html form format.

Returns:

the registered html form format

html

public static ERXRestFormat html()

Returns the registered html format.

Returns:

the registered html format

json

public static ERXRestFormat json()

Returns the registered json format.

Returns:

the registered json format

plist

public static ERXRestFormat plist()

Returns the registered plist format.

Returns:

the registered plist format

xml

public static ERXRestFormat xml()

Returns the registered xml format.

Returns:

the registered xml format

bplist

public static ERXRestFormat bplist()

Returns the registered plist format.

Returns:

the registered plist format

name

public String name()

Returns the name of this format.

Returns:

the name of this format

parser

public IERXRestParser parser()

writer

public IERXRestWriter writer()

delegate

public ERXRestFormat.Delegate delegate()

parse

public ERXRestRequestNode parse(String str)

Returns a parsed ERXRestRequestNode using this format's parser.

Parameters:

str - the string to parse

Returns:

the parsed request node

parse

public ERXRestRequestNode parse(String str,
                                ERXRestContext context)

Returns a parsed ERXRestRequestNode using this format's parser.

Parameters:

str - the string to parse

context - the REST context

Returns:

the parsed request node

parse

public ERXRestRequestNode parse(IERXRestRequest request,
                                ERXRestContext context)

Returns a parsed ERXRestRequestNode using this format's parser.

Parameters:

request - the request

context - the REST context

Returns:

the parsed request node

toString

public String toString(Object obj)

Returns the formatted version of the given object using a recursive "All" filter and the default rest delegate.

Parameters:

obj - the object to render

Returns:

obj rendered using this format

toString

public String toString(Object obj,
                       ERXKeyFilter filter)

Returns the formatted version of the given object using a recursive "All" filter.

Parameters:

obj - the object to render

filter - the filter to apply to the object

Returns:

obj rendered using this format

toString

public String toString(Object obj,
                       ERXRestContext context)

Returns the formatted version of the given object using a recursive "All" filter.

Parameters:

obj - the object to render

context - the REST context

Returns:

obj rendered using this format

toString

public String toString(Object obj,
                       ERXKeyFilter filter,
                       ERXRestContext context)

Returns the formatted version of the given object.

Parameters:

obj - the object to render

filter - the filter to apply to the object

context - the REST context

Returns:

obj rendered using this format

toString

public String toString(com.webobjects.eocontrol.EOClassDescription classDescription,
                       List<?> list,
                       ERXKeyFilter filter,
                       ERXRestContext context)

Returns the formatted version of the given list.

Parameters:

classDescription - the class description for the elements of the list

list - the list

filter - the filter

context - the REST context

Returns:

list rendered using this format

toString

public String toString()

Overrides:

toString in class Object

hasFormatNamed

public static boolean hasFormatNamed(String name)

Returns true if there is a format registered with the given name.

Parameters:

name - the name to lookup

Returns:

true if there is a format registered with the given name

formatNamed

public static ERXRestFormat formatNamed(String name)

registerFormatNamed

public static ERXRestFormat registerFormatNamed(IERXRestParser parser,
                                                IERXRestWriter writer,
                                                ERXRestFormat.Delegate delegate,
                                                String... names)

registerFormatNamed

public static ERXRestFormat registerFormatNamed(ERXRestFormat format,
                                                String name)