com.exalead.mercury.mami.consolidation.v10

Class EnablePushAPI

java.lang.Object

com.exalead.mercury.mami.consolidation.v10.CSSpecific

com.exalead.mercury.mami.consolidation.v10.PersistableConsolidationComponent

com.exalead.mercury.mami.consolidation.v10.EnablePushAPI

All Implemented Interfaces:

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

public class EnablePushAPI
extends PersistableConsolidationComponent
implements com.exalead.util.Checkable, java.io.Serializable

Enables the PushAPI, allowing documents to be pushed to the consolidation chain

See Also:

Serialized Form

Field Summary

Fields inherited from class com.exalead.mercury.mami.consolidation.v10.PersistableConsolidationComponent

DEFAULT_PERSISTENT, persistent

Fields inherited from class com.exalead.mercury.mami.consolidation.v10.CSSpecific

instanceName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this EnablePushAPI.
static EnablePushAPI	fromString(java.lang.String s) String representation of this EnablePushAPI.
EnablePushAPI	makeCopy() Creates and returns a deep copy of this EnablePushAPI.
static EnablePushAPI	readFrom(java.io.InputStream is) Read this EnablePushAPI from an XML fragment.
java.lang.String	toString() String representation of this EnablePushAPI.
EnablePushAPI	withInstanceName(java.lang.String instanceName)
EnablePushAPI	withPersistent(boolean persistent)
EnablePushAPI	withPersistent(java.lang.Boolean persistent)
void	writeTo(java.io.OutputStream os) Write this EnablePushAPI as an XML fragment

Methods inherited from class com.exalead.mercury.mami.consolidation.v10.PersistableConsolidationComponent

isPersistent, setPersistent

Methods inherited from class com.exalead.mercury.mami.consolidation.v10.CSSpecific

getInstanceName, setInstanceName

Methods inherited from class java.lang.Object

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

Constructor Detail

EnablePushAPI

public EnablePushAPI()

EnablePushAPI

public EnablePushAPI(EnablePushAPI o)

Copy constructor

Method Detail

withPersistent

public EnablePushAPI withPersistent(boolean persistent)

Overrides:

withPersistent in class PersistableConsolidationComponent

withPersistent

public EnablePushAPI withPersistent(java.lang.Boolean persistent)

Overrides:

withPersistent in class PersistableConsolidationComponent

withInstanceName

public EnablePushAPI withInstanceName(java.lang.String instanceName)

Overrides:

withInstanceName in class PersistableConsolidationComponent

makeCopy

public EnablePushAPI makeCopy()

Creates and returns a deep copy of this EnablePushAPI.

Overrides:

makeCopy in class PersistableConsolidationComponent

readFrom

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

Read this EnablePushAPI 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

Write this EnablePushAPI as an XML fragment

Overrides:

writeTo in class PersistableConsolidationComponent

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this EnablePushAPI.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this EnablePushAPI.

Overrides:

toString in class PersistableConsolidationComponent

check

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

Checks this EnablePushAPI.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class PersistableConsolidationComponent

Throws:

com.exalead.util.TypedException