com.exalead.mercury.mami.search.v20

Class Command

java.lang.Object

com.exalead.mercury.mami.search.v20.Command

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

BaseFetchCommand, BaseSearchCommand, DictionaryCommand, GeoCommand, IsAliveCommand, SecurityCommand, SuggestCommand

public abstract class Command
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Search API command

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Command.Transformer<T>
static interface	Command.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	base
static java.lang.String	DEFAULT_BASE

Constructor Summary

Constructors

Constructor and Description
Command()
Command(Command o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(Command.Transformer<T> transformer, T[] t)
abstract void	accept(Command.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this Command.
static Command	fromString(java.lang.String s) String representation of this Command.
java.lang.String	getBase() HTTP path for this command
Command	makeCopy()
static Command	readFrom(java.io.InputStream is) Read this Command from an XML fragment.
void	setBase(java.lang.String base) HTTP path for this command
java.lang.String	toString() String representation of this Command.
Command	withBase(java.lang.String base)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

base

public java.lang.String base

DEFAULT_BASE

public static final java.lang.String DEFAULT_BASE

See Also:

Constant Field Values

Constructor Detail

Command

public Command()

Command

public Command(Command o)

Copy constructor

Method Detail

setBase

public void setBase(java.lang.String base)

HTTP path for this command

getBase

public java.lang.String getBase()

HTTP path for this command

withBase

public Command withBase(java.lang.String base)

makeCopy

public Command makeCopy()

readFrom

public static Command readFrom(java.io.InputStream is)
                        throws javax.xml.bind.JAXBException

Read this Command from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Command fromString(java.lang.String s)
                          throws javax.xml.bind.JAXBException,
                                 java.io.UnsupportedEncodingException

String representation of this Command.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Command.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Command.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

public abstract void accept(Command.Visitor visitor)
                     throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public abstract <T> T accept(Command.Transformer<T> transformer,
                             T[] t)
                      throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException