|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NavigationStateBuilder
A builder used by the core cartridge handlers to create NavigationState and RecordState objects.
NavigationState and RecordState objects can be serialized to strings by callingNavigationState#toString()
and RecordState#toString()
, respectively. The exact format of
this serialization depends on the specific NavigationStateBuilder
implementation and the way in which it is configured.
Implementing classes must not keep state between calls because multiple threads may access a builder instance at the same time. It is also important not to modify any arguments passed into the builder.
Method Summary | |
---|---|
NavigationState |
parseNavigationState(String queryString,
String pathInfo,
String characterEncoding)
Create a NavigationState parsed from a query string, a path info, and a character encoding. |
RecordState |
parseRecordState(String queryString,
String pathInfo,
String characterEncoding)
Create a RecordState parsed from a path info, a query string, and a character encoding. |
Method Detail |
---|
NavigationState parseNavigationState(String queryString, String pathInfo, String characterEncoding) throws NavigationException
Create a NavigationState parsed from a query string, a path info, and a character encoding. Depending on the NavigationStateBuilder implementation and the way in which it is configured, the navigation state may be described by the query string, the path info, or some combination of the two.
queryString
- The query string that describes the
NavigationStatepathInfo
- The path info that describes the
NavigationStatecharacterEncoding
- The character encoding of the path info
and query string
NavigationException
- if a NavigationState could
not be constructed from the given query string and path infoRecordState parseRecordState(String queryString, String pathInfo, String characterEncoding) throws NavigationException
Create a RecordState parsed from a path info, a query string, and a character encoding. Depending on the NavigationStateBuilder implementation and the way in which it is configured, the record state may be described by the query string, the path info, or some combination of the two.
queryString
- The query string that describes the
RecordStatepathInfo
- The path info that describes the RecordStatecharacterEncoding
- The character encoding of the path info
and query string
NavigationException
- if a RecordState could
not be constructed from the given query string and path info
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |