org.jibx.custom.classes

Class SharedNestingBase

java.lang.Object

org.jibx.custom.classes.CustomBase

org.jibx.custom.classes.SharedNestingBase

Direct Known Subclasses:

NestingBase, NestingBase

public abstract class SharedNestingBase
extends CustomBase

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

Fields

Modifier and Type	Field and Description
static StringArray	s_allowedAttributes Enumeration of allowed attribute names

Fields 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

Constructor and Description
SharedNestingBase(SharedNestingBase parent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	convertName(String base) Convert class or unprefixed field name to element or attribute name using current format.
String	getFormatterClass() Get JavaDoc formatter class name.
String	getNamespace() Get the namespace for schema definitions.
int	getNamespaceStyle() Get namespace derivation style.
int	getNameStyle() Get name style.
protected String	getSpecifiedNamespace() 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	isUseJavaDocs() 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.
void	setNameStyle(Integer style) Set name style.

Methods inherited from class org.jibx.custom.classes.CustomBase

convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes

Methods inherited from class java.lang.Object

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

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes

Enumeration of allowed attribute names

Constructor Detail

SharedNestingBase

public SharedNestingBase(SharedNestingBase parent)

Constructor.

Parameters:

parent -

Method Detail

getFormatterClass

public String getFormatterClass()

Get JavaDoc formatter class name.

Returns:

namespace style

getSpecifiedNamespace

protected String getSpecifiedNamespace()

Get namespace specified on this element. This method is only intended for use by subclasses - otherwise the getNamespace() method should instead be used.

Returns:

namespace (null if none)

getNamespaceStyle

public int getNamespaceStyle()

Get namespace derivation style.

Returns:

namespace style

setNamespaceStyle

public void setNamespaceStyle(Integer style)

Set namespace derivation style.

Parameters:

style - (null if none at this level)

getNameStyle

public int getNameStyle()

Get name style.

Returns:

name style

setNameStyle

public void setNameStyle(Integer style)

Set name style.

Parameters:

style - (null if none at this level)

getNamespace

public final String getNamespace()

Get the namespace for schema definitions. This value must be set by subclasses using the setNamespace(String) method.

Returns:

schema namespace

setNamespace

protected void setNamespace(String ns)

Set the namespace to be used for schema definitions. This method is only intended for use by subclasses.

Parameters:

ns -

isPrimitiveRequired

public boolean isPrimitiveRequired(String type)

Check if primitive value should be treated as required. If not set at any nesting level, the default is true.

Parameters:

type - primitive type

Returns:

true if required value, false if not

isObjectRequired

public boolean isObjectRequired(String type)

Check if object value should be treated as required. If not set at any nesting level, the default is false.

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 is true.

Returns:

force names flag

convertName

public String convertName(String base)

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