Top Description Constructors Methods
org.hibernate.validator.internal.xml

public abstract Class AbstractStaxBuilder

extends Object
Class Inheritance
Known Direct Subclasses
org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder, org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder.SimpleConfigurationsStaxBuilder, org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder.PropertyStaxBuilder, org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder.ValueExtractorsStaxBuilder, org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder.ConstraintMappingsStaxBuilder, org.hibernate.validator.internal.xml.config.ValidationConfigStaxBuilder.ExecutableValidationStaxBuilder, org.hibernate.validator.internal.xml.mapping.AbstractConstrainedElementStaxBuilder, org.hibernate.validator.internal.xml.mapping.AbstractConstrainedExecutableElementStaxBuilder, org.hibernate.validator.internal.xml.mapping.AbstractMultiValuedElementStaxBuilder, org.hibernate.validator.internal.xml.mapping.AbstractOneLineStringStaxBuilder, org.hibernate.validator.internal.xml.mapping.BeanStaxBuilder, org.hibernate.validator.internal.xml.mapping.ClassConstraintTypeStaxBuilder, org.hibernate.validator.internal.xml.mapping.ConstraintDefinitionStaxBuilder, org.hibernate.validator.internal.xml.mapping.ConstraintDefinitionStaxBuilder.ValidatedByStaxBuilder, org.hibernate.validator.internal.xml.mapping.ConstraintMappingsStaxBuilder, org.hibernate.validator.internal.xml.mapping.ConstraintTypeStaxBuilder, org.hibernate.validator.internal.xml.mapping.ConstraintTypeStaxBuilder.AnnotationParameterStaxBuilder, org.hibernate.validator.internal.xml.mapping.ContainerElementTypeStaxBuilder, org.hibernate.validator.internal.xml.mapping.CrossParameterStaxBuilder, org.hibernate.validator.internal.xml.mapping.GroupConversionStaxBuilder, org.hibernate.validator.internal.xml.mapping.ValidStaxBuilder
Imports
java.util.Optional, javax.xml.namespace.QName, javax.xml.stream.XMLEventReader, .XMLStreamException, javax.xml.stream.events.Attribute, .StartElement, .XMLEvent

Other Stax xml builders should extend from this one. Provides some common functionality like reading an attribute value or value of a simple tag.
Author
Marko Bekhta

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected boolean

Returns:

true if corresponding event can be processed by current builder, false otherwise
accept
(XMLEvent
an event to check
xmlEvent
)

Checks if the given XMLEvent is a StartElement and if the corresponding xml tag can be processed based on a tag name.

protected abstract void
add(XMLEventReader xmlEventReader, XMLEvent xmlEvent)

protected abstract String
public boolean
process(XMLEventReader xmlEventReader, XMLEvent xmlEvent)

protected Optional<String>

Returns:

a value of an attribute if it is present, Optional#empty() otherwise
readAttribute
(StartElement
an element to get an attribute from
startElement
,
QName
a QName of an attribute to read
qName
)

Reads a value of an attribute of a given element.

protected String

Returns:

a value of a current xml tag as a string
readSingleElement
(XMLEventReader
a current XMLEventReader
xmlEventReader
)

Reads a value between a simple tag element.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractStaxBuilderback to summary
public AbstractStaxBuilder()

Method Detail

acceptback to summary
protected boolean accept(XMLEvent xmlEvent)

Checks if the given XMLEvent is a StartElement and if the corresponding xml tag can be processed based on a tag name.

Parameters
xmlEvent:XMLEvent

an event to check

Returns:boolean

true if corresponding event can be processed by current builder, false otherwise

addback to summary
protected abstract void add(XMLEventReader xmlEventReader, XMLEvent xmlEvent) throws XMLStreamException
getAcceptableQNameback to summary
protected abstract String getAcceptableQName()
processback to summary
public boolean process(XMLEventReader xmlEventReader, XMLEvent xmlEvent)
readAttributeback to summary
protected Optional<String> readAttribute(StartElement startElement, QName qName)

Reads a value of an attribute of a given element.

Parameters
startElement:StartElement

an element to get an attribute from

qName:QName

a QName of an attribute to read

Returns:Optional<String>

a value of an attribute if it is present, Optional#empty() otherwise

readSingleElementback to summary
protected String readSingleElement(XMLEventReader xmlEventReader) throws XMLStreamException

Reads a value between a simple tag element. In case of a <someTag>some-value</someTag> will return some-value as a string.

Parameters
xmlEventReader:XMLEventReader

a current XMLEventReader

Returns:String

a value of a current xml tag as a string