com.exalead.indexing.analysis.v10

Class CustomDirectiveCondition

java.lang.Object

com.exalead.indexing.analysis.v10.AcceptCondition

com.exalead.indexing.analysis.v10.CustomDirectiveCondition

All Implemented Interfaces:

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

public class CustomDirectiveCondition
extends AcceptCondition
implements com.exalead.util.Checkable, java.io.Serializable

A condition that matches if the document has the specified directive name, with an optional specific value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.AcceptCondition

AcceptCondition.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	directiveName
java.lang.String	directiveValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(AcceptCondition.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this CustomDirectiveCondition.
static CustomDirectiveCondition	fromString(java.lang.String s) String representation of this CustomDirectiveCondition.
java.lang.String	getDirectiveName() The expected directive name
java.lang.String	getDirectiveValue() An optional expected value for the given directive
CustomDirectiveCondition	makeCopy() Creates and returns a deep copy of this CustomDirectiveCondition.
static CustomDirectiveCondition	readFrom(java.io.InputStream is) Read this CustomDirectiveCondition from an XML fragment.
void	setDirectiveName(java.lang.String directiveName) The expected directive name
void	setDirectiveValue(java.lang.String directiveValue) An optional expected value for the given directive
java.lang.String	toString() String representation of this CustomDirectiveCondition.
CustomDirectiveCondition	withDirectiveName(java.lang.String directiveName)
CustomDirectiveCondition	withDirectiveValue(java.lang.String directiveValue)
void	writeTo(java.io.OutputStream os) Write this CustomDirectiveCondition as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

directiveName

public java.lang.String directiveName

directiveValue

public java.lang.String directiveValue

Constructor Detail

CustomDirectiveCondition

public CustomDirectiveCondition()

CustomDirectiveCondition

public CustomDirectiveCondition(CustomDirectiveCondition o)

Copy constructor

Method Detail

setDirectiveName

public void setDirectiveName(java.lang.String directiveName)

The expected directive name

getDirectiveName

public java.lang.String getDirectiveName()

The expected directive name

withDirectiveName

public CustomDirectiveCondition withDirectiveName(java.lang.String directiveName)

setDirectiveValue

public void setDirectiveValue(java.lang.String directiveValue)

An optional expected value for the given directive

getDirectiveValue

public java.lang.String getDirectiveValue()

An optional expected value for the given directive

withDirectiveValue

public CustomDirectiveCondition withDirectiveValue(java.lang.String directiveValue)

makeCopy

public CustomDirectiveCondition makeCopy()

Creates and returns a deep copy of this CustomDirectiveCondition.

Overrides:

makeCopy in class AcceptCondition

readFrom

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

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

Overrides:

writeTo in class AcceptCondition

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomDirectiveCondition.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomDirectiveCondition.

Overrides:

toString in class AcceptCondition

check

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

Checks this CustomDirectiveCondition.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AcceptCondition

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class AcceptCondition

Throws:

com.exalead.util.TypedException