Package org.jibx.ws.wsdl.tools.custom
Class ValueCustom
java.lang.Object
org.jibx.custom.classes.CustomBase
org.jibx.custom.classes.SharedValueBase
org.jibx.ws.wsdl.tools.custom.ValueCustom
Method parameter or return value customization information.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Integer
Style for elements used to wrap parameter values in request element.private String
private List
Documentation text (as org.w3.dom.Node components).static final StringArray
Enumeration of allowed attribute names.private static final 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
ConstructorsModifierConstructorDescriptionprotected
ValueCustom
(NestingBase parent, String name) Constructor. -
Method Summary
Modifier and TypeMethodDescription(package private) void
Complete customization information based on supplied type.Get value type to be bound.Get value documentation node list.private static ValueCustom
Parameter value unmarshalling factory.protected void
preSet
(IUnmarshallingContext uctx) Make sure all attributes are defined when unmarshalling (only used by binding).private static ValueCustom
Return value unmarshalling factory.private void
setElement
(String text, IUnmarshallingContext ictx) Set element name method.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
Methods inherited from class org.jibx.custom.classes.CustomBase
convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes
-
Field Details
-
s_logger
private static final Logger s_loggerLogger for class. -
ELEMENT_STYLE
Style for elements used to wrap parameter values in request element. -
s_allowedAttributes
Enumeration of allowed attribute names. -
m_boundType
-
m_documentation
Documentation text (as org.w3.dom.Node components).
-
-
Constructor Details
-
ValueCustom
Constructor.- Parameters:
parent
-name
-
-
-
Method Details
-
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
Get value documentation node list. This method should only be used after thecomplete(IClass, List, Boolean, String)
method is called.- Returns:
- list of documentation nodes (
null
if none)
-
complete
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 informationdocs
- default documentation text (null
if none)req
- required member flag (null
if unspecified)itype
- item type from signature (null
if unknown)
-
preSet
Make sure all attributes are defined when unmarshalling (only used by binding).- Parameters:
uctx
- unmarshalling context
-
setElement
Set element name method. This is intended for use during unmarshalling, so it needs to allow for being called with anull
value.- Parameters:
text
- (null
if attribute not present)ictx
-
-
parameterFactory
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
Return value unmarshalling factory. This gets the containing element so that the standard constructor can be used.- Parameters:
ictx
-- Returns:
- created instance
-