org.enhydra.xml.xmlc.deferredparsing
Class XMLCCreateOptions

java.lang.Object
  |
  +--org.enhydra.xml.xmlc.deferredparsing.XMLCCreateOptions

public class XMLCCreateOptions
extends Object

Provides options for XMLObject creation.

Of the available options, at least one of the following three are required to be set...

Options to be used for deferred parsing
xmlcClass
xmlcClassName
Option to be used for dynamic loading
dynMarkupFilePath

All other options are entirely optional. Options starting with "dyn", such as dynDomFactoryClassName apply only when dynamic loading is used. All other options apply to both deferred parsing and dynamic loading.


Constructor Summary
XMLCCreateOptions()
           
 
Method Summary
 String getDynDomFactoryClassName()
           
 String getDynMarkupFilePath()
           
 Locale getFallbackLocale()
           
(package private)  Locale getPrimaryLocale()
           
(package private)  Locale getSecondaryLocale()
           
 Locale getUserLocale()
           
 Class getXmlcClass()
           
 String getXmlcClassName()
           
(package private)  XMLCCreateOptions setDefaultFallbackLocale(Locale defaultFallbackLocale)
           
 XMLCCreateOptions setDynDomFactoryClassName(String dynDomFactoryClassName)
           
 XMLCCreateOptions setDynMarkupFilePath(String dynMarkupFilePath)
          Use this option for dynamic loading; that is without build-time-generated XMLC classes.
 XMLCCreateOptions setFallbackLocale(Locale fallbackLocale)
           
 XMLCCreateOptions setUserLocale(Locale userLocale)
           
 XMLCCreateOptions setXmlcClass(Class xmlcClass)
          Use this option for deferred parsing; that is with build-time-generated XMLC classes.
 XMLCCreateOptions setXmlcClassName(String xmlcClassName)
          Use this option for deferred parsing; that is with build-time-generated XMLC classes.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLCCreateOptions

public XMLCCreateOptions()
Method Detail

getXmlcClass

public Class getXmlcClass()
Returns:
the value applied to setXmlcClass(Class) or null if not set

setXmlcClass

public XMLCCreateOptions setXmlcClass(Class xmlcClass)
Use this option for deferred parsing; that is with build-time-generated XMLC classes. Alternatively, use setXmlcClassName(String). This option is required unless one of xmlcClassName or dynMarkupFilePath is set.
Parameters:
xmlcClass - the XMLC class, either interface or implementation
Returns:
the current object, fluent style
See Also:
setXmlcClassName(String)

getXmlcClassName

public String getXmlcClassName()
Returns:
the value applied to setXmlcClassName(String) or null if not set

setXmlcClassName

public XMLCCreateOptions setXmlcClassName(String xmlcClassName)
Use this option for deferred parsing; that is with build-time-generated XMLC classes. Alternatively, use setXmlcClass(Class). This option is required unless one of xmlcClass or dynMarkupFilePath is set.
Parameters:
xmlcClassName - the fully qualified name of the XMLC class, either interface or implementation
Returns:
the current object, fluent style
See Also:
setXmlcClass(Class)

getDynMarkupFilePath

public String getDynMarkupFilePath()
Returns:
the value applied to setDynMarkupFilePath(String) or null if not set

setDynMarkupFilePath

public XMLCCreateOptions setDynMarkupFilePath(String dynMarkupFilePath)
Use this option for dynamic loading; that is without build-time-generated XMLC classes. This option is required unless one of xmlcClass or xmlcClassName is set.
Parameters:
dynMarkupFilePath - the path to the source file, generally a relative path (relative to resource dirs, the classpath, etc...), trimmed if non-null
Returns:
the current object, fluent style
See Also:
setDynDomFactoryClassName(String)

getDynDomFactoryClassName

public String getDynDomFactoryClassName()
Returns:
the value applied to setDynDomFactoryClassName(String) or null if not set

setDynDomFactoryClassName

public XMLCCreateOptions setDynDomFactoryClassName(String dynDomFactoryClassName)
Parameters:
dynDomFactoryClassName - the fully qualified name of the DOM factory to use, optional and only relevant when using dynamic loading
Returns:
the current object, fluent style
See Also:
setDynMarkupFilePath(String)

getUserLocale

public Locale getUserLocale()
Returns:
the value applied to setUserLocale(Locale) or null if not set

setUserLocale

public XMLCCreateOptions setUserLocale(Locale userLocale)
Parameters:
userLocale - the user locale, e.g., the Locale defined in an HttpSerlvetRequest
Returns:
the current object, fluent style
See Also:
setFallbackLocale(Locale)

getFallbackLocale

public Locale getFallbackLocale()
Returns:
the value applied to setFallbackLocale(Locale) or null if not set

setFallbackLocale

public XMLCCreateOptions setFallbackLocale(Locale fallbackLocale)
Parameters:
fallbackLocale - the fallback locale to be used if the user locale is null or user locale-named markup file is not found, i.e., the developer preferred fallback
Returns:
the current object, fluent style
See Also:
setUserLocale(Locale)

setDefaultFallbackLocale

XMLCCreateOptions setDefaultFallbackLocale(Locale defaultFallbackLocale)

getPrimaryLocale

Locale getPrimaryLocale()

getSecondaryLocale

Locale getSecondaryLocale()


Copyright © 1999-2007 enhydra.org (Mark Diekhans, David Li, Richard Kunze, Jacob Kjome). All Rights reserved.