org.umber.catalan.process.workers.io
Class IoProperties

java.lang.Object
  extended byorg.umber.catalan.process.properties.BaseWorkProperties
      extended byorg.umber.catalan.process.properties.ChainedProperties
          extended byorg.umber.catalan.process.properties.CommonProperties
              extended byorg.umber.catalan.process.workers.io.IoProperties
All Implemented Interfaces:
IWorkProperties

public class IoProperties
extends CommonProperties

Specialized properties container for IoWorker.

Author:
jsheets

Constructor Summary
IoProperties(IWorkProperties baseProps)
          Creates a new instance of IoProperties.
 
Method Summary
 boolean getAppend()
          Retrieves the value of the "append" property.
 java.io.File getBaseDir()
          Retrieves the value of the "base-dir" property.
 boolean getEncodeXml()
          Retrieves the value of the "encode-xml" property.
 java.lang.String getFormat()
          Retrieves the value of the "format" property.
 boolean getKeepOriginal()
          Retrieves the value of the "keep-original" property.
 IOAdapter getOutput()
          Retrieves the value of the "output" property.
 boolean getStrictWhitespace()
          Retrieves the value of the "strict-whitespace" property.
 
Methods inherited from class org.umber.catalan.process.properties.CommonProperties
getCommand, getCount, getEndIndex, getStartIndex
 
Methods inherited from class org.umber.catalan.process.properties.ChainedProperties
addPropertySet, getProperty, getPropertyNames, getPropertySets, toString
 
Methods inherited from class org.umber.catalan.process.properties.BaseWorkProperties
asMap, asMap, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.umber.catalan.process.properties.IWorkProperties
getProperty, getPropertyAsBoolean, getPropertyAsDatum, getPropertyAsMap, getPropertyAsNumber, getPropertyAsString, getPropertyNames
 

Constructor Detail

IoProperties

public IoProperties(IWorkProperties baseProps)
Creates a new instance of IoProperties.

Parameters:
baseProps - properties to wrap
Method Detail

getFormat

public java.lang.String getFormat()
Retrieves the value of the "format" property. Only acknowledges the values "text", "xml", and "binary". Defaults to "text".

Returns:
the "format" property

getKeepOriginal

public boolean getKeepOriginal()
Retrieves the value of the "keep-original" property.

Returns:
the "keep-original" property

getStrictWhitespace

public boolean getStrictWhitespace()
Retrieves the value of the "strict-whitespace" property. This property is only used when importing xml content.

Returns:
the "strict-whitespace" property

getAppend

public boolean getAppend()
Retrieves the value of the "append" property.

Returns:
the "append" property

getEncodeXml

public boolean getEncodeXml()
Retrieves the value of the "encode-xml" property.

Returns:
the "encode-xml" property

getOutput

public IOAdapter getOutput()
Retrieves the value of the "output" property. The value of this property will be wrapped in an IoAdapter object if it is non-null.

Returns:
the "output" property

getBaseDir

public java.io.File getBaseDir()
Retrieves the value of the "base-dir" property.

Returns:
the "base-dir" property