ValueCustom (JiBX Java data binding to XML

java.lang.Object
- org.jibx.custom.classes.CustomBase
- - org.jibx.custom.classes.SharedValueBase
  - - org.jibx.ws.wsdl.tools.custom.ValueCustom

```
public class ValueCustom
extends SharedValueBase
```
Method parameter or return value customization information.

Author:

Dennis M. Sosnoski

Field Summary

Fields
Modifier and Type	Field	Description
`private static java.lang.Integer`	`ELEMENT_STYLE`	Style for elements used to wrap parameter values in request element.
`private java.lang.String`	`m_boundType`
`private java.util.List`	`m_documentation`	Documentation text (as org.w3.dom.Node components).
`static StringArray`	`s_allowedAttributes`	Enumeration of allowed attribute names.
`private static Logger`	`s_logger`	Logger for class.

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
Modifier Constructor Description

protected ValueCustom(NestingBase parent, java.lang.String name)
Constructor.

Constructors
Modifier	Constructor	Description
`protected`	`ValueCustom(NestingBase parent, java.lang.String name)`	Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`complete(IClass info, java.util.List docs, java.lang.Boolean req, java.lang.String itype)`	Complete customization information based on supplied type.
`java.lang.String`	`getBoundType()`	Get value type to be bound.
`java.util.List`	`getDocumentation()`	Get value documentation node list.
`private static ValueCustom`	`parameterFactory(IUnmarshallingContext ictx)`	Parameter value unmarshalling factory.
`protected void`	`preSet(IUnmarshallingContext uctx)`	Make sure all attributes are defined when unmarshalling (only used by binding).
`private static ValueCustom`	`returnFactory(IUnmarshallingContext ictx)`	Return value unmarshalling factory.
`private void`	`setElement(java.lang.String text, IUnmarshallingContext ictx)`	Set element name method.

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

Methods inherited from class org.jibx.custom.classes.SharedValueBase
convertMemberNameCase, fillType, getActualType, getBaseName, getClassCustom, getCreateType, getFactoryMethod, getItemName, getItemType, getStatedType, getStyle, getWorkingType, getXmlName, isCollection, isElementForced, isRequired, setBaseName, setElementForced, setItemName, setItemType, setStyle, setXmlName

- Field Detail
  - s_logger
```
private static final Logger s_logger
```
    Logger for class.
  - ELEMENT_STYLE
```
private static final java.lang.Integer ELEMENT_STYLE
```
    Style for elements used to wrap parameter values in request element.
  - s_allowedAttributes
```
public static final StringArray s_allowedAttributes
```
    Enumeration of allowed attribute names.
  - m_boundType
```
private java.lang.String m_boundType
```
  - m_documentation
```
private java.util.List m_documentation
```
    Documentation text (as org.w3.dom.Node components).
- Constructor Detail
  - ValueCustom
```
protected ValueCustom(NestingBase parent,
                      java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    parent -
    
    name -
- Method Detail
  - getBoundType
```
public java.lang.String getBoundType()
```
    Get value type to be bound. This is the same as the plain value type for a simple (non-collection); for an array value, it's just the array item type; and for a non-array collection it takes the same form as a generic type declaration, with the actual item type enclosed in a less-than/greater-than sign pair following the base type.
    
    Returns:
    
    parmaterized type
  - getDocumentation
```
public java.util.List getDocumentation()
```
    Get value documentation node list. This method should only be used after the complete(IClass, List, Boolean, String) method is called.
    
    Returns:
    
    list of documentation nodes (null if none)
  - complete
```
void complete(IClass info,
              java.util.List docs,
              java.lang.Boolean req,
              java.lang.String itype)
```
    Complete customization information based on supplied type. If the type information has not previously been set, this will set it. It will also derive the appropriate XML name, if not previously set.
    
    Parameters:
    
    info - value type information
    
    docs - default documentation text (null if none)
    
    req - required member flag (null if unspecified)
    
    itype - item type from signature (null if unknown)
  - preSet
```
protected void preSet(IUnmarshallingContext uctx)
```
    Make sure all attributes are defined when unmarshalling (only used by binding).
    
    Parameters:
    
    uctx - unmarshalling context
  - setElement
```
private void setElement(java.lang.String text,
                        IUnmarshallingContext ictx)
```
    Set element name method. This is intended for use during unmarshalling, so it needs to allow for being called with a null value.
    
    Parameters:
    
    text - (null if attribute not present)
    
    ictx -
  - parameterFactory
```
private static ValueCustom parameterFactory(IUnmarshallingContext ictx)
                                     throws JiBXException
```
    Parameter value unmarshalling factory. This gets the containing element and the name so that the standard constructor can be used.
    
    Parameters:
    
    ictx -
    
    Returns:
    
    created instance
    
    Throws:
    
    JiBXException
  - returnFactory
```
private static ValueCustom returnFactory(IUnmarshallingContext ictx)
```
    Return value unmarshalling factory. This gets the containing element so that the standard constructor can be used.
    
    Parameters:
    
    ictx -
    
    Returns:
    
    created instance

Class ValueCustom

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

s_logger

ELEMENT_STYLE

s_allowedAttributes

m_boundType

m_documentation

Constructor Detail

ValueCustom

Method Detail

getBoundType

getDocumentation

complete

preSet

setElement

parameterFactory

returnFactory