org.jibx.binding.model
Interface IComponent

All Known Implementing Classes:
CollectionElement, StructureElement, StructureElementBase, ValueElement

public interface IComponent

Child component interface definition. This is the basic interface implemented by every binding definition element that actually participates in the nested structure of a binding (as opposed to elements such as format elements, which are simply convenience shortcuts). It defines the hooks used to handle structure validation of a binding definition model.

Author:
Dennis M. Sosnoski

Method Summary
 java.lang.String getName()
          Get name.
 IClass getType()
          Get value type information.
 java.lang.String getUri()
          Get specified namespace URI.
 boolean hasAttribute()
          Check if component defines one or more attribute values of the containing element.
 boolean hasContent()
          Check if component defines one or more elements or text values as children of the containing element.
 boolean hasName()
          Check if component has a name.
 boolean isImplicit()
          Check if this structure implicitly uses the containing object.
 boolean isOptional()
          Check if component is an optional item.
 

Method Detail

isOptional

boolean isOptional()
Check if component is an optional item.

Returns:
true if optional, false if required

hasAttribute

boolean hasAttribute()
Check if component defines one or more attribute values of the containing element. This method is only valid after validation.

Returns:
true if one or more attribute values defined for containing element, false if not

hasContent

boolean hasContent()
Check if component defines one or more elements or text values as children of the containing element. This method is only valid after validation.

Returns:
true if one or more content values defined for containing element, false if not

hasName

boolean hasName()
Check if component has a name.

Returns:
true if component has a name, false if not

getName

java.lang.String getName()
Get name.

Returns:
name text

getUri

java.lang.String getUri()
Get specified namespace URI.

Returns:
namespace URI (null if not set)

getType

IClass getType()
Get value type information. This call is only meaningful after prevalidation.

Returns:
type information

isImplicit

boolean isImplicit()
Check if this structure implicitly uses the containing object. This call is only meaningful after prevalidation.

Returns:
true if using the containing object, false if own object


Project Web Site