com.exalead.mercury.mami.connect.v10

Class ConnectorScanMode

java.lang.Object

com.exalead.mercury.mami.connect.v10.ConnectorScanMode

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectorScanMode.DefaultConfig

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_HAS_CONFIG
protected ConnectorScanMode.DefaultConfig	defaultConfig
java.lang.String	description
com.exalead.mercury.component.config.descriptor.Descriptor	descriptor
boolean	hasConfig
java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConnectorScanMode.
static ConnectorScanMode	fromString(java.lang.String s) String representation of this ConnectorScanMode.
ConnectorScanMode.DefaultConfig	getDefaultConfig()
java.lang.String	getDescription() Comprehensive description of the scan mode.
com.exalead.mercury.component.config.descriptor.Descriptor	getDescriptor() Get the config descriptor
java.lang.String	getName() Name of the scan mode.
boolean	isHasConfig() True if the scan mode has a custom configuration, False otherwise.
ConnectorScanMode	makeCopy() Creates and returns a deep copy of this ConnectorScanMode.
static ConnectorScanMode	readFrom(java.io.InputStream is) Read this ConnectorScanMode from an XML fragment.
void	setDefaultConfig(ConnectorScanMode.DefaultConfig __value)
void	setDescription(java.lang.String description) Comprehensive description of the scan mode.
void	setDescriptor(com.exalead.mercury.component.config.descriptor.Descriptor descriptor) Get the config descriptor
void	setHasConfig(boolean hasConfig) True if the scan mode has a custom configuration, False otherwise.
void	setName(java.lang.String name) Name of the scan mode.
java.lang.String	toString() String representation of this ConnectorScanMode.
ConnectorScanMode	withDefaultConfig(java.util.Collection<KeyValue> __values)
ConnectorScanMode	withDefaultConfig(ConnectorScanMode.DefaultConfig __value)
ConnectorScanMode	withDefaultConfig(KeyValue... __values)
ConnectorScanMode	withDescription(java.lang.String description)
ConnectorScanMode	withDescriptor(com.exalead.mercury.component.config.descriptor.Descriptor descriptor)
ConnectorScanMode	withHasConfig(boolean hasConfig)
ConnectorScanMode	withHasConfig(java.lang.Boolean hasConfig)
ConnectorScanMode	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this ConnectorScanMode as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

description

public java.lang.String description

hasConfig

public boolean hasConfig

DEFAULT_HAS_CONFIG

public static final boolean DEFAULT_HAS_CONFIG

See Also:

Constant Field Values

defaultConfig

protected ConnectorScanMode.DefaultConfig defaultConfig

descriptor

public com.exalead.mercury.component.config.descriptor.Descriptor descriptor

Constructor Detail

ConnectorScanMode

public ConnectorScanMode()

ConnectorScanMode

public ConnectorScanMode(ConnectorScanMode o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name of the scan mode.

getName

public java.lang.String getName()

Name of the scan mode.

withName

public ConnectorScanMode withName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

Comprehensive description of the scan mode.

getDescription

public java.lang.String getDescription()

Comprehensive description of the scan mode.

withDescription

public ConnectorScanMode withDescription(java.lang.String description)

setHasConfig

public void setHasConfig(boolean hasConfig)

True if the scan mode has a custom configuration, False otherwise.

isHasConfig

public boolean isHasConfig()

True if the scan mode has a custom configuration, False otherwise.

withHasConfig

public ConnectorScanMode withHasConfig(boolean hasConfig)

withHasConfig

public ConnectorScanMode withHasConfig(java.lang.Boolean hasConfig)

getDefaultConfig

public ConnectorScanMode.DefaultConfig getDefaultConfig()

setDefaultConfig

public void setDefaultConfig(ConnectorScanMode.DefaultConfig __value)

withDefaultConfig

public ConnectorScanMode withDefaultConfig(KeyValue... __values)

withDefaultConfig

public ConnectorScanMode withDefaultConfig(java.util.Collection<KeyValue> __values)

withDefaultConfig

public ConnectorScanMode withDefaultConfig(ConnectorScanMode.DefaultConfig __value)

setDescriptor

public void setDescriptor(com.exalead.mercury.component.config.descriptor.Descriptor descriptor)

Get the config descriptor

getDescriptor

public com.exalead.mercury.component.config.descriptor.Descriptor getDescriptor()

Get the config descriptor

withDescriptor

public ConnectorScanMode withDescriptor(com.exalead.mercury.component.config.descriptor.Descriptor descriptor)

makeCopy

public ConnectorScanMode makeCopy()

Creates and returns a deep copy of this ConnectorScanMode.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConnectorScanMode.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConnectorScanMode.

Overrides:

toString in class java.lang.Object

check

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

Checks this ConnectorScanMode.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException