com.primus.searchcommon.parseroptions
Class ParserOptions

java.lang.Object
  extended by com.primus.searchcommon.parseroptions.ParserOptions
All Implemented Interfaces:
java.io.Serializable

public class ParserOptions
extends java.lang.Object
implements java.io.Serializable

Convenience class for building up parser options XML. All element names are enumerated for each request type, but not all element values are. Options can be added, but not removed. Many options can be repeated with different values: consult the supporting documentation for details.

See Also:
Serialized Form

Constructor Summary
ParserOptions()
           
 
Method Summary
 ParserOptions addOption(com.primus.frameworks.Enum opt, java.lang.Object value)
          Adds an option and its value to the XML
 java.lang.String toString()
          Returns the parserOptions XML, including the outer parserOptions tag.
 java.lang.String toXml()
          Same as toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParserOptions

public ParserOptions()
Method Detail

addOption

public ParserOptions addOption(com.primus.frameworks.Enum opt,
                               java.lang.Object value)
Adds an option and its value to the XML

Parameters:
opt - The option to add
value - The value for the option. Could be a String or and Enum-derived type, if one exists for the option.

toString

public java.lang.String toString()
Returns the parserOptions XML, including the outer parserOptions tag.

Overrides:
toString in class java.lang.Object
Returns:
XML string

toXml

public java.lang.String toXml()
Same as toString

Returns:
XML string
See Also:
toString()