com.exalead.mercury.mami.connect.v10

Class SourcePreviewConfig

java.lang.Object

com.exalead.mercury.mami.connect.v10.SourcePreviewConfig

All Implemented Interfaces:

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

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

Defines the configuration for image and HTML preview of the documents
of a source.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowHTMLPreview
boolean	allowImagePreview
static boolean	DEFAULT_ALLOW_H_T_M_L_PREVIEW
static boolean	DEFAULT_ALLOW_IMAGE_PREVIEW

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SourcePreviewConfig.
static SourcePreviewConfig	fromString(java.lang.String s) String representation of this SourcePreviewConfig.
boolean	isAllowHTMLPreview()
boolean	isAllowImagePreview()
SourcePreviewConfig	makeCopy() Creates and returns a deep copy of this SourcePreviewConfig.
static SourcePreviewConfig	readFrom(java.io.InputStream is) Read this SourcePreviewConfig from an XML fragment.
void	setAllowHTMLPreview(boolean allowHTMLPreview)
void	setAllowImagePreview(boolean allowImagePreview)
java.lang.String	toString() String representation of this SourcePreviewConfig.
SourcePreviewConfig	withAllowHTMLPreview(boolean allowHTMLPreview)
SourcePreviewConfig	withAllowHTMLPreview(java.lang.Boolean allowHTMLPreview)
SourcePreviewConfig	withAllowImagePreview(boolean allowImagePreview)
SourcePreviewConfig	withAllowImagePreview(java.lang.Boolean allowImagePreview)
void	writeTo(java.io.OutputStream os) Write this SourcePreviewConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

allowHTMLPreview

public boolean allowHTMLPreview

DEFAULT_ALLOW_H_T_M_L_PREVIEW

public static final boolean DEFAULT_ALLOW_H_T_M_L_PREVIEW

See Also:

Constant Field Values

allowImagePreview

public boolean allowImagePreview

DEFAULT_ALLOW_IMAGE_PREVIEW

public static final boolean DEFAULT_ALLOW_IMAGE_PREVIEW

See Also:

Constant Field Values

Constructor Detail

SourcePreviewConfig

public SourcePreviewConfig()

SourcePreviewConfig

public SourcePreviewConfig(SourcePreviewConfig o)

Copy constructor

Method Detail

setAllowHTMLPreview

public void setAllowHTMLPreview(boolean allowHTMLPreview)

isAllowHTMLPreview

public boolean isAllowHTMLPreview()

withAllowHTMLPreview

public SourcePreviewConfig withAllowHTMLPreview(boolean allowHTMLPreview)

withAllowHTMLPreview

public SourcePreviewConfig withAllowHTMLPreview(java.lang.Boolean allowHTMLPreview)

setAllowImagePreview

public void setAllowImagePreview(boolean allowImagePreview)

isAllowImagePreview

public boolean isAllowImagePreview()

withAllowImagePreview

public SourcePreviewConfig withAllowImagePreview(boolean allowImagePreview)

withAllowImagePreview

public SourcePreviewConfig withAllowImagePreview(java.lang.Boolean allowImagePreview)

makeCopy

public SourcePreviewConfig makeCopy()

Creates and returns a deep copy of this SourcePreviewConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SourcePreviewConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SourcePreviewConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this SourcePreviewConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException