Package org.jibx.custom.classes
Class SharedNestingBase
java.lang.Object
org.jibx.custom.classes.CustomBase
org.jibx.custom.classes.SharedNestingBase
- Direct Known Subclasses:
NestingBase
,NestingBase
Base class for all binding customizations that can contain other customizations. This includes inherited values
shared with customization extensions (in particular, the WSDL extensions).
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private String
private Integer
private Integer
private Integer
private Boolean
static final StringArray
Enumeration of allowed attribute namesFields inherited from class org.jibx.custom.classes.CustomBase
CAMEL_CASE_NAMES, DERIVE_BY_PACKAGE, DERIVE_FIXED, DERIVE_NONE, DOTTED_NAMES, HYPHENATED_NAMES, REQUIRE_ALL, REQUIRE_NONE, REQUIRE_OBJECTS, REQUIRE_PRIMITIVES, s_namespaceStyleEnum, s_nameStyleEnum, s_requireEnum, UNDERSCORED_NAMES, UPPER_CAMEL_CASE_NAMES
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconvertName
(String base) Convert class or unprefixed field name to element or attribute name using current format.Get JavaDoc formatter class name.final String
Get the namespace for schema definitions.int
Get namespace derivation style.private String
Namespace style get text method.int
Get name style.private String
Name style get text method.private String
Required get text method.protected String
Get namespace specified on this element.boolean
isObjectRequired
(String type) Check if object value should be treated as required.boolean
isPrimitiveRequired
(String type) Check if primitive value should be treated as required.boolean
Check if JavaDocs should be used for documentation.protected void
setNamespace
(String ns) Set the namespace to be used for schema definitions.void
setNamespaceStyle
(Integer style) Set namespace derivation style.private void
setNamespaceStyleText
(String text, IUnmarshallingContext ictx) Namespace style set text method.void
setNameStyle
(Integer style) Set name style.private void
setNameStyleText
(String text, IUnmarshallingContext ictx) Name style set text method.private void
setRequireText
(String text, IUnmarshallingContext ictx) Required set text method.Methods inherited from class org.jibx.custom.classes.CustomBase
convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes
-
Field Details
-
s_allowedAttributes
Enumeration of allowed attribute names -
m_javadocFormatter
-
m_namespace
-
m_namespaceStyle
-
m_nameStyle
-
m_require
-
m_useJavaDocs
-
m_actualNamespace
-
-
Constructor Details
-
Method Details
-
getFormatterClass
Get JavaDoc formatter class name.- Returns:
- namespace style
-
getSpecifiedNamespace
Get namespace specified on this element. This method is only intended for use by subclasses - otherwise thegetNamespace()
method should instead be used.- Returns:
- namespace (
null
if none)
-
getNamespaceStyle
public int getNamespaceStyle()Get namespace derivation style.- Returns:
- namespace style
-
setNamespaceStyle
Set namespace derivation style.- Parameters:
style
- (null
if none at this level)
-
getNameStyle
public int getNameStyle()Get name style.- Returns:
- name style
-
setNameStyle
Set name style.- Parameters:
style
- (null
if none at this level)
-
getNamespace
Get the namespace for schema definitions. This value must be set by subclasses using thesetNamespace(String)
method.- Returns:
- schema namespace
-
setNamespace
Set the namespace to be used for schema definitions. This method is only intended for use by subclasses.- Parameters:
ns
-
-
isPrimitiveRequired
Check if primitive value should be treated as required. If not set at any nesting level, the default istrue
.- Parameters:
type
- primitive type- Returns:
true
if required value,false
if not
-
isObjectRequired
Check if object value should be treated as required. If not set at any nesting level, the default isfalse
.- Parameters:
type
- object type- Returns:
true
if required value,false
if not
-
isUseJavaDocs
public boolean isUseJavaDocs()Check if JavaDocs should be used for documentation. If not set at any nesting level, the default istrue
.- Returns:
- force names flag
-
convertName
Convert class or unprefixed field name to element or attribute name using current format.- Parameters:
base
- class or simple field name to be converted- Returns:
- element or attribute name
-
setNameStyleText
Name style set text method. This is intended for use during unmarshalling. TODO: add validation- Parameters:
text
-ictx
-
-
getNameStyleText
Name style get text method. This is intended for use during marshalling.- Returns:
- text
-
setNamespaceStyleText
Namespace style set text method. This is intended for use during unmarshalling. TODO: add validation- Parameters:
text
-ictx
-
-
getNamespaceStyleText
Namespace style get text method. This is intended for use during marshalling.- Returns:
- text
-
setRequireText
Required set text method. This is intended for use during unmarshalling. TODO: add validation- Parameters:
text
-ictx
-
-
getRequireText
Required get text method. This is intended for use during marshalling.- Returns:
- text
-