All Superinterfaces:: Element

All Known Implementing Classes:: XMLElementAdapter, XMLElementImpl

@ClassVersion(sourceVersion="$Id: XMLElement.java 1071 2023-09-30 01:49:32Z tquadrat $") @API(status=STABLE, since="0.0.5") public sealed interface XMLElement extends Element permits XMLElementImpl

The definition of an XMLElement.

The default implementation of the methods addCDATA(CharSequence), addChild(XMLElement), addComment(CharSequence), addText(CharSequence), setAttribute(String, CharSequence, Optional), setNamespace(String), setNamespace(URI), setNamespace(String,String), setNamespace(String,URI), and setNamespace(Namespace) will always throw an IllegalOperationException; classes that implement this interface will have to provide appropriate implementations for these methods if they want to support the respective feature.

Author:: Thomas Thrien (thomas.thrien@tquadrat.org)
Version:: $Id: XMLElement.java 1071 2023-09-30 01:49:32Z tquadrat $
Since:: 0.0.5
UML Diagram: ⁠
UML Diagram for "org.tquadrat.foundation.xml.builder.XMLElement"
⁠

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

XMLElement.Flags

The flags that are used to configure a new instance of XMLElement (respectively an instance of an implementation of this interface.
Field Summary

Fields

Modifier and Type

Field

Description

static final XMLElement[]

EMPTY_XMLElement_ARRAY

An empty array of XMLElement objects.

static final Optional<? extends CharSequence>

NO_APPEND

The indicator that values for an attribute should not be appended.
Method Summary

Modifier and Type

Method

Description

default XMLElement

addCDATA(boolean flag)

Adds the provided boolean value as a CDATA element to this XML element.

default XMLElement

addCDATA(char c)

Adds the provided char value as a CDATA element to this XML element.

default XMLElement

addCDATA(double number)

Adds the provided double value as a CDATA element to this XML element.

default XMLElement

addCDATA(int number)

Adds the provided int value as a CDATA element to this XML element.

default XMLElement

addCDATA(long number)

Adds the provided long value as a CDATA element to this XML element.

default <E extends Enum<E>> XMLElement

addCDATA(E value)

Adds the provided enum instance as a CDATA element to this XML element.

default XMLElement

addCDATA(Boolean flag)

Adds the provided Boolean instance as a CDATA element to this XML element.

default XMLElement

addCDATA(Character c)

Adds the provided Character instance as a CDATA element to this XML element.

default XMLElement

addCDATA(CharSequence text)

Adds a CDATA element to this XML element.

default XMLElement

addCDATA(Number number)

Adds the provided Number instance as a CDATA element to this XML element.

default XMLElement

addCDATA(Instant date)

Adds the provided Instant instance as a CDATA element to this XML element.

default XMLElement

addCDATA(LocalDate date)

Adds the provided LocalDate instance as a CDATA element to this XML element.

default XMLElement

addCDATA(LocalDateTime date)

Adds the provided LocalDateTime instance as a CDATA element to this XML element.

default XMLElement

addCDATA(ZonedDateTime date)

Adds the provided ZonedDateTime instance as a CDATA element to this XML element.

default <E extends XMLElement> XMLElement

addChild(E child)

Adds a child to this element.

default XMLElement

addComment(CharSequence comment)

Adds a comment.

default XMLElement

addPredefinedMarkup(CharSequence markup)

Adds predefined markup.

default XMLElement

addText(boolean flag)

Adds the provided boolean value as text to this element.

default XMLElement

addText(char c)

Adds the provided char value as text to this element.

default XMLElement

addText(double number)

Adds the provided double value as text to this element.

default XMLElement

addText(int number)

Adds the provided int value as text to this element.

default XMLElement

addText(long number)

Adds the provided long value as text to this element.

default <E extends Enum<E>> XMLElement

addText(E value)

Adds the provided enum instance as text element to this element.

default XMLElement

addText(Boolean flag)

Adds the provided Boolean instance as text to this element.

default XMLElement

addText(Character c)

Adds the provided Character instance as text to this element.

default XMLElement

addText(CharSequence text)

Adds text to this element.

default XMLElement

addText(Number number)

Adds the provided Number instance as text to this element.

default XMLElement

addText(Instant date)

Adds the provided Instant instance as text to this element.

default XMLElement

addText(LocalDate date)

Adds the provided LocalDate instance as text to this element.

default XMLElement

addText(LocalDateTime date)

Adds the provided LocalDateTime instance as text to this element.

default XMLElement

addText(ZonedDateTime date)

Adds the provided ZonedDateTime instance as text to this element.

Set<XMLElement.Flags>

getFlags()

Returns the flags for this element.

default XMLElement

setAttribute(String name, boolean flag)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, double number)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, int number)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, long number)

Sets the attribute with the given name.

default <E extends Enum<E>> XMLElement

setAttribute(String name, E enumValue)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, Boolean flag)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, CharSequence value)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, CharSequence value, Optional<? extends CharSequence> append)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, Number number)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, Instant date)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, LocalDate date)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, LocalDateTime date)

Sets the attribute with the given name.

default XMLElement

setAttribute(String name, ZonedDateTime date)

Sets the attribute with the given name.

default XMLElement

setAttributeIfNotEmpty(String name, CharSequence value)

Sets the attribute with the given name if the provided value is not empty.

default XMLElement

setAttributeIfNotEmpty(String name, Optional<? extends CharSequence> optional)

Sets the attribute with the given name if the provided value is not empty.

default XMLElement

setId(String id)

Sets the id for the element.

default XMLElement

setNamespace(String identifier)

Sets the given namespace.

default XMLElement

setNamespace(String prefix, String identifier)

Sets the given namespace.

default XMLElement

setNamespace(String prefix, URI identifier)

Sets the given namespace.

default XMLElement

setNamespace(URI identifier)

Sets the given namespace.

default XMLElement

setNamespace(Namespace namespace)

Sets the given namespace.

<E extends Element> void

setParent(E parent)

Sets the parent for this element.

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Element
getAttribute, getAttributes, getChildren, getElementName, getNamespaces, getParent, hasChildren, isBlock, toString

Field Details
- EMPTY_XMLElement_ARRAY
  
  static final XMLElement[] EMPTY_XMLElement_ARRAY
  
  An empty array of XMLElement objects.
- NO_APPEND
  
  static final Optional<? extends CharSequence> NO_APPEND
  
  The indicator that values for an attribute should not be appended.
  See Also:
  
  setAttribute(String, CharSequence, Optional)
Method Details
- addCDATA
  
  default XMLElement addCDATA(boolean flag) throws IllegalOperationException
  
  Adds the provided boolean value as a CDATA element to this XML element.
  
  To convert the boolean to text, the method Boolean.toString(boolean) is used.
  
  Parameters:
  
  flag - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(Boolean flag) throws IllegalOperationException
  
  Adds the provided Boolean instance as a CDATA element to this XML element.
  
  To convert the boolean to text, the method Boolean.toString() is used.
  
  Parameters:
  
  flag - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(char c) throws IllegalOperationException
  
  Adds the provided char value as a CDATA element to this XML element.
  
  To convert the character to text, the method Character.toString(char) is used.
  
  Parameters:
  
  c - The character.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(Character c) throws IllegalOperationException
  
  Adds the provided Character instance as a CDATA element to this XML element.
  
  To convert the character to text, the method Character.toString() is used.
  
  Parameters:
  
  c - The character.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(CharSequence text) throws IllegalOperationException
  
  Adds a CDATA element to this XML element.
  
  Parameters:
  
  text - The text.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(double number) throws IllegalOperationException
  
  Adds the provided double value as a CDATA element to this XML element.
  
  To convert the number to text, the method Double.toString(double) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default <E extends Enum<E>> XMLElement addCDATA(E value) throws IllegalOperationException
  
  Adds the provided enum instance as a CDATA element to this XML element.
  
  To convert the value to text, the method Enum.name() is used.
  
  Type Parameters:
  
  E - The type of the enum value.
  
  Parameters:
  
  value - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(Instant date) throws IllegalOperationException
  
  Adds the provided Instant instance as a CDATA element to this XML element.
  
  To convert the date to text, the method Instant.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(int number) throws IllegalOperationException
  
  Adds the provided int value as a CDATA element to this XML element.
  
  To convert the number to text, the method Integer.toString(int) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(LocalDate date) throws IllegalOperationException
  
  Adds the provided LocalDate instance as a CDATA element to this XML element.
  
  To convert the date to text, the method LocalDate.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(LocalDateTime date) throws IllegalOperationException
  
  Adds the provided LocalDateTime instance as a CDATA element to this XML element.
  
  To convert the date to text, the method LocalDateTime.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(long number) throws IllegalOperationException
  
  Adds the provided long value as a CDATA element to this XML element.
  
  To convert the number to text, the method Long.toString(long) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(Number number) throws IllegalOperationException
  
  Adds the provided Number instance as a CDATA element to this XML element.
  
  To convert the number to text, the method Object.toString() is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addCDATA
  
  default XMLElement addCDATA(ZonedDateTime date) throws IllegalOperationException
  
  Adds the provided ZonedDateTime instance as a CDATA element to this XML element.
  
  To convert the date to text, the method ZonedDateTime.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addChild
  
  default <E extends XMLElement> XMLElement addChild(E child) throws IllegalArgumentException, IllegalOperationException, IllegalStateException
  
  Adds a child to this element.
  
  Type Parameters:
  
  E - The implementation type for the children.
  
  Parameters:
  
  child - The child to add.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - The given child is not valid for this element.
  
  IllegalOperationException - No children are allowed for this element.
  
  IllegalStateException - The child has already a parent that is not this element.
- addComment
  
  default XMLElement addComment(CharSequence comment) throws IllegalOperationException
  
  Adds a comment.
  
  Parameters:
  
  comment - The comment text.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No comment allowed for this element.
- addPredefinedMarkup
  
  default XMLElement addPredefinedMarkup(CharSequence markup) throws IllegalOperationException
  
  Adds predefined markup.
  
  The given markup will not be validated, it just may not be null. So the caller is responsible that it will be proper markup.
  
  As the markup may be formatted differently (or not formatted at all), the pretty printed output may be distorted when this is used.
  
  Parameters:
  
  markup - The predefined markup.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No children are allowed for this element.
- addText
  
  default XMLElement addText(boolean flag) throws IllegalOperationException
  
  Adds the provided boolean value as text to this element.
  
  To convert the boolean to text, the method Boolean.toString(boolean) is used.
  
  Parameters:
  
  flag - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(Boolean flag) throws IllegalOperationException
  
  Adds the provided Boolean instance as text to this element.
  
  To convert the boolean to text, the method Boolean.toString() is used.
  
  Parameters:
  
  flag - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(char c) throws IllegalOperationException
  
  Adds the provided char value as text to this element.
  
  To convert the character to text, the method Character.toString(char) is used.
  
  Parameters:
  
  c - The character.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(Character c) throws IllegalOperationException
  
  Adds the provided Character instance as text to this element.
  
  To convert the character to text, the method Character.toString() is used.
  
  Parameters:
  
  c - The character.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(CharSequence text) throws IllegalOperationException
  
  Adds text to this element. Special characters will be escaped according to the rules for the respective SGML flavour.
  
  Parameters:
  
  text - The text.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(double number) throws IllegalOperationException
  
  Adds the provided double value as text to this element.
  
  To convert the number to text, the method Double.toString(double) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default <E extends Enum<E>> XMLElement addText(E value) throws IllegalOperationException
  
  Adds the provided enum instance as text element to this element.
  
  To convert the value to text, the method Enum.name() is used.
  
  Type Parameters:
  
  E - The type of the enum value.
  
  Parameters:
  
  value - The value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(Instant date) throws IllegalOperationException
  
  Adds the provided Instant instance as text to this element.
  
  To convert the date to text, the method Instant.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(int number) throws IllegalOperationException
  
  Adds the provided int value as text to this element.
  
  To convert the number to text, the method Integer.toString(int) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(LocalDate date) throws IllegalOperationException
  
  Adds the provided LocalDate instance as text to this element.
  
  To convert the date to text, the method LocalDate.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(LocalDateTime date) throws IllegalOperationException
  
  Adds the provided LocalDateTime instance as text to this element.
  
  To convert the date to text, the method LocalDateTime.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(long number) throws IllegalOperationException
  
  Adds the provided long value as text to this element.
  
  To convert the number to text, the method Long.toString(long) is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(Number number) throws IllegalOperationException
  
  Adds the provided Number instance as text to this element.
  
  To convert the number to text, the method Object.toString() is used.
  
  Parameters:
  
  number - The number.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- addText
  
  default XMLElement addText(ZonedDateTime date) throws IllegalOperationException
  
  Adds the provided ZonedDateTime instance as text to this element.
  
  To convert the date to text, the method ZonedDateTime.toString() is used.
  
  Parameters:
  
  date - The date.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - No text allowed for this element.
- getFlags
  
  Set<XMLElement.Flags> getFlags()
  
  Returns the flags for this element.
  Returns:
  
  The flags.
  
  See Also:
  
  XMLElement.Flags
- setAttribute
  
  default XMLElement setAttribute(String name, boolean flag) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Boolean.toString(boolean) to convert the provided flag to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  flag - The attribute's value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, Boolean flag) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Boolean.toString() to convert the provided flag to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  flag - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, CharSequence value) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  value - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, CharSequence value, Optional<? extends CharSequence> append) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  value - The attribute's value; if null the attribute will be removed.
  
  append - If not empty (NO_APPEND), the new value will be appended to an already existing one, and the provided char sequence is used as the separator.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, double number) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Double.toString(double) to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  number - The attribute's value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default <E extends Enum<E>> XMLElement setAttribute(String name, E enumValue) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Enum.name() to convert the provided value to a String.
  
  Type Parameters:
  
  E - The concrete enum type of value.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  enumValue - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, Instant date) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Instant.toString() to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  date - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, int number) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Integer.toString(int) to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  number - The attribute's value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, LocalDate date) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses LocalDate.toString() to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  date - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, LocalDateTime date) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses LocalDateTime.toString() to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  date - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, long number) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Long.toString(long) to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  number - The attribute's value.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, Number number) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses Object.toString() to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  number - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttribute
  
  default XMLElement setAttribute(String name, ZonedDateTime date) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name.
  
  The method uses ZonedDateTime.toString() to convert the provided number to a String.
  
  Parameters:
  
  name - The name of the attribute; the name is case-sensitive.
  
  date - The attribute's value; if null the attribute will be removed.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttributeIfNotEmpty
  
  default XMLElement setAttributeIfNotEmpty(String name, CharSequence value) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name if the provided value is not empty.
  
  The method uses StringUtils.isNotEmpty(CharSequence) to test if the given value is empty.
  
  Parameters:
  
  name - The name of the attribute.
  
  value - The value for the attribute; can be null.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setAttributeIfNotEmpty
  
  default XMLElement setAttributeIfNotEmpty(String name, Optional<? extends CharSequence> optional) throws IllegalArgumentException, IllegalOperationException
  
  Sets the attribute with the given name if the provided value is not empty.
  
  Parameters:
  
  name - The name of the attribute.
  
  optional - The value for the attribute.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element
  
  IllegalOperationException - No attributes are allowed for this element.
- setId
  
  default XMLElement setId(String id) throws IllegalArgumentException, IllegalOperationException
  
  Sets the id for the element.
  
  The value will be validated using the method that is provided by a call to XMLBuilderUtils.getNMTokenValidator().
  Parameters:
  
  id - The id.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalArgumentException - An attribute with the given name is not valid for the element or the value is not a valid NMToken.
  
  IllegalOperationException - No attributes are allowed for this element.
  
  See Also:
  
  CommonConstants.XMLATTRIBUTE_Id
- setNamespace
  
  default XMLElement setNamespace(String identifier) throws IllegalOperationException, URISyntaxException
  
  Sets the given namespace.
  
  Parameters:
  
  identifier - The namespace identifier.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - Namespaces are not allowed for this element.
  
  URISyntaxException - The provided URI String is invalid.
- setNamespace
  
  default XMLElement setNamespace(URI identifier) throws IllegalOperationException
  
  Sets the given namespace.
  
  Parameters:
  
  identifier - The namespace identifier.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - Namespaces are not allowed for this element.
- setNamespace
  
  default XMLElement setNamespace(String prefix, String identifier) throws IllegalOperationException, URISyntaxException
  
  Sets the given namespace.
  
  The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().
  
  Parameters:
  
  prefix - The namespace prefix.
  
  identifier - The namespace identifier.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - Namespaces are not allowed for this element.
  
  URISyntaxException - The provided URI String is invalid.
- setNamespace
  
  default XMLElement setNamespace(String prefix, URI identifier) throws IllegalOperationException
  
  Sets the given namespace.
  
  The given prefix is validated using the method that is provided by XMLBuilderUtils.getPrefixValidator().
  
  Parameters:
  
  prefix - The namespace prefix.
  
  identifier - The namespace identifier.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - Namespaces are not allowed for this element.
- setNamespace
  
  default XMLElement setNamespace(Namespace namespace) throws IllegalOperationException
  
  Sets the given namespace.
  
  Parameters:
  
  namespace - The namespace.
  
  Returns:
  
  This instance.
  
  Throws:
  
  IllegalOperationException - Namespaces are not allowed for this element.
- setParent
  
  <E extends Element> void setParent(E parent)
  
  Sets the parent for this element.
  
  Specified by:
  
  setParent in interface Element
  
  Type Parameters:
  
  E - The implementation of Element.
  
  Parameters:
  
  parent - The parent.

Interface XMLElement

UML Diagram for "org.tquadrat.foundation.xml.builder.XMLElement"

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Element

Field Details

EMPTY_XMLElement_ARRAY

NO_APPEND

Method Details

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addCDATA

addChild

addComment

addPredefinedMarkup

addText

addText

addText

addText

addText

addText

addText

addText

addText

addText

addText

addText

addText

addText

getFlags

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttribute

setAttributeIfNotEmpty

setAttributeIfNotEmpty

setId

setNamespace

setNamespace

setNamespace

setNamespace

setNamespace

setParent