Package org.jboss.as.controller

Class PersistentResourceXMLDescription.PersistentResourceXMLBuilder

java.lang.Object

org.jboss.as.controller.PersistentResourceXMLDescription.PersistentResourceXMLBuilder

All Implemented Interfaces:

PersistentResourceXMLDescription.Builder

Enclosing class:

PersistentResourceXMLDescription

public static final class PersistentResourceXMLDescription.PersistentResourceXMLBuilder
extends Object
implements PersistentResourceXMLDescription.Builder

Method Summary

Modifier and Type	Method	Description
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addAttribute(AttributeDefinition attribute)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addAttribute(AttributeDefinition attribute, AttributeParser attributeParser)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addAttribute(AttributeDefinition attribute, AttributeParser attributeParser, AttributeMarshaller attributeMarshaller)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addAttributes(Stream<? extends AttributeDefinition> attributes)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addAttributes(AttributeDefinition... attributes)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addChild(PersistentResourceXMLDescription description)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	addChild(PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder)
PersistentResourceXMLDescription	build()
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setAdditionalOperationsGenerator(PersistentResourceXMLDescription.AdditionalOperationsGenerator additionalOperationsGenerator)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setForcedName(String forcedName)	Deprecated, for removal: This API element is subject to removal in a future version. Use an xml attribute to provide the name of the resource.
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setMarshallDefaultValues(boolean marshallDefault)	If set to false, default attribute values won't be persisted
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setNameAttributeName(String nameAttributeName)	Sets name for "name" attribute that is used for wildcard resources.
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setNoAddOperation(boolean noAddOperation)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setUseElementsForGroups(boolean useElementsForGroups)	Sets whether attributes with an attribute group defined should be persisted to a child element whose name is the name of the group.
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setUseValueAsElementName(boolean useValueAsElementName)	Deprecated, for removal: This API element is subject to removal in a future version. Use setNameAttributeName(String)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setXmlElementName(String xmlElementName)
PersistentResourceXMLDescription.PersistentResourceXMLBuilder	setXmlWrapperElement(String xmlWrapperElement)

Methods inherited from class java.lang.Object

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

Method Detail

addChild

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addChild(PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder)

addChild

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addChild(PersistentResourceXMLDescription description)

Specified by:

addChild in interface PersistentResourceXMLDescription.Builder

addAttribute

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addAttribute(AttributeDefinition attribute)

Specified by:

addAttribute in interface PersistentResourceXMLDescription.Builder

addAttribute

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addAttribute(AttributeDefinition attribute,
                                                                                  AttributeParser attributeParser)

addAttribute

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addAttribute(AttributeDefinition attribute,
                                                                                  AttributeParser attributeParser,
                                                                                  AttributeMarshaller attributeMarshaller)

Specified by:

addAttribute in interface PersistentResourceXMLDescription.Builder

addAttributes

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addAttributes(AttributeDefinition... attributes)

Specified by:

addAttributes in interface PersistentResourceXMLDescription.Builder

addAttributes

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder addAttributes(Stream<? extends AttributeDefinition> attributes)

Specified by:

addAttributes in interface PersistentResourceXMLDescription.Builder

setXmlWrapperElement

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setXmlWrapperElement(String xmlWrapperElement)

Specified by:

setXmlWrapperElement in interface PersistentResourceXMLDescription.Builder

setXmlElementName

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setXmlElementName(String xmlElementName)

Specified by:

setXmlElementName in interface PersistentResourceXMLDescription.Builder

setUseValueAsElementName

@Deprecated(forRemoval=true)
public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setUseValueAsElementName(boolean useValueAsElementName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setNameAttributeName(String)

setNoAddOperation

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setNoAddOperation(boolean noAddOperation)

Specified by:

setNoAddOperation in interface PersistentResourceXMLDescription.Builder

setAdditionalOperationsGenerator

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setAdditionalOperationsGenerator(PersistentResourceXMLDescription.AdditionalOperationsGenerator additionalOperationsGenerator)

Specified by:

setAdditionalOperationsGenerator in interface PersistentResourceXMLDescription.Builder

setForcedName

@Deprecated(forRemoval=true)
public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setForcedName(String forcedName)

Deprecated, for removal: This API element is subject to removal in a future version.

Use an xml attribute to provide the name of the resource.

This method permit to set a forced name for resource created by parser. This is useful when xml tag haven't an attribute defining the name for the resource, but the tag name itself is sufficient to decide the name for the resource For example when you have 2 different tag of the same xsd type representing same resource with different name

Parameters:

forcedName - the name to be forced as resourceName

Returns:

the PersistentResourceXMLBuilder itself

setUseElementsForGroups

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setUseElementsForGroups(boolean useElementsForGroups)

Sets whether attributes with an attribute group defined should be persisted to a child element whose name is the name of the group. Child elements will be ordered based on the order in which attributes are added to this builder. Child elements for attribute groups will be ordered before elements for child resources.

Specified by:

setUseElementsForGroups in interface PersistentResourceXMLDescription.Builder

Parameters:

useElementsForGroups - true if child elements should be used.

Returns:

a builder that can be used for further configuration or to build the xml description

setMarshallDefaultValues

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setMarshallDefaultValues(boolean marshallDefault)

If set to false, default attribute values won't be persisted

Parameters:

marshallDefault - weather default values should be persisted or not.

Returns:

builder

setNameAttributeName

public PersistentResourceXMLDescription.PersistentResourceXMLBuilder setNameAttributeName(String nameAttributeName)

Sets name for "name" attribute that is used for wildcard resources. It defines name of attribute one resource xml element to be used for such identifier If not set it defaults to "name"

Specified by:

setNameAttributeName in interface PersistentResourceXMLDescription.Builder

Parameters:

nameAttributeName - xml attribute name to be used for resource name

Returns:

builder

build

public PersistentResourceXMLDescription build()

Specified by:

build in interface PersistentResourceXMLDescription.Builder