com.exalead.mercury.mami.deploy.v10

Class ScratchHook

java.lang.Object

com.exalead.mercury.mami.deploy.v10.ScratchHook

All Implemented Interfaces:

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

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

A Hook to plug custom exa code on BuildGroup scratch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classId
java.util.List<KeyValue>	keyValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ScratchHook.
static ScratchHook	fromString(java.lang.String s) String representation of this ScratchHook.
java.lang.String	getClassId() The specified class must implement the com.exalead.mercury.indexing.CustomScratchHook Exascript interface.
java.util.List<KeyValue>	getKeyValue()
ScratchHook	makeCopy() Creates and returns a deep copy of this ScratchHook.
static ScratchHook	readFrom(java.io.InputStream is) Read this ScratchHook from an XML fragment.
void	setClassId(java.lang.String classId) The specified class must implement the com.exalead.mercury.indexing.CustomScratchHook Exascript interface.
java.lang.String	toString() String representation of this ScratchHook.
ScratchHook	withClassId(java.lang.String classId)
ScratchHook	withKeyValue(java.util.Collection<KeyValue> __values)
ScratchHook	withKeyValue(KeyValue... __values)
void	writeTo(java.io.OutputStream os) Write this ScratchHook as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

public java.util.List<KeyValue> keyValue

classId

public java.lang.String classId

Constructor Detail

ScratchHook

public ScratchHook()

ScratchHook

public ScratchHook(ScratchHook o)

Copy constructor

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public ScratchHook withKeyValue(KeyValue... __values)

withKeyValue

public ScratchHook withKeyValue(java.util.Collection<KeyValue> __values)

setClassId

public void setClassId(java.lang.String classId)

The specified class must implement
the com.exalead.mercury.indexing.CustomScratchHook Exascript interface.

getClassId

public java.lang.String getClassId()

The specified class must implement
the com.exalead.mercury.indexing.CustomScratchHook Exascript interface.

withClassId

public ScratchHook withClassId(java.lang.String classId)

makeCopy

public ScratchHook makeCopy()

Creates and returns a deep copy of this ScratchHook.

readFrom

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

Read this ScratchHook 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 ScratchHook as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ScratchHook.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ScratchHook.

Overrides:

toString in class java.lang.Object

check

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

Checks this ScratchHook.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException