com.exalead.mercury.component.config.descriptor

Class PathField

java.lang.Object

com.exalead.mercury.component.config.descriptor.Item

com.exalead.mercury.component.config.descriptor.Field

com.exalead.mercury.component.config.descriptor.PathField

All Implemented Interfaces:

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

public class PathField
extends Field
implements com.exalead.util.Checkable, java.io.Serializable

A file system location, either a file or a directory.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.exalead.mercury.component.config.descriptor.Field

allowEmpty, DEFAULT_ALLOW_EMPTY, defaultValue

Fields inherited from class com.exalead.mercury.component.config.descriptor.Item

DEFAULT_IS_HIDDEN, DEFAULT_IS_MANDATORY, description, isHidden, isMandatory, name, ordering, title

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PathField.
static PathField	fromString(java.lang.String s) String representation of this PathField.
PathField	makeCopy() Creates and returns a deep copy of this PathField.
static PathField	readFrom(java.io.InputStream is) Read this PathField from an XML fragment.
java.lang.String	toString() String representation of this PathField.
PathField	withAllowEmpty(boolean allowEmpty)
PathField	withAllowEmpty(java.lang.Boolean allowEmpty)
PathField	withDefaultValue(java.lang.String defaultValue)
PathField	withDescription(java.lang.String description)
PathField	withIsHidden(boolean isHidden)
PathField	withIsHidden(java.lang.Boolean isHidden)
PathField	withIsMandatory(boolean isMandatory)
PathField	withIsMandatory(java.lang.Boolean isMandatory)
PathField	withName(java.lang.String name)
PathField	withOrdering(int ordering)
PathField	withOrdering(java.lang.Integer ordering)
PathField	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this PathField as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Field

getDefaultValue, isAllowEmpty, setAllowEmpty, setDefaultValue

Methods inherited from class com.exalead.mercury.component.config.descriptor.Item

getDescription, getName, getOrdering, getTitle, isIsHidden, isIsMandatory, setDescription, setIsHidden, setIsMandatory, setName, setOrdering, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

PathField

public PathField()

PathField

public PathField(PathField o)

Copy constructor

Method Detail

withDefaultValue

public PathField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public PathField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public PathField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public PathField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public PathField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public PathField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public PathField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public PathField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public PathField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public PathField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public PathField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public PathField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

makeCopy

public PathField makeCopy()

Creates and returns a deep copy of this PathField.

Overrides:

makeCopy in class Field

readFrom

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

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

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PathField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PathField.

Overrides:

toString in class Field

check

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

Checks this PathField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException