Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.builder

Interface ProcessingInstruction

All Superinterfaces:

Element

All Known Implementing Classes:

ProcessingInstructionImpl

@ClassVersion(sourceVersion="$Id: ProcessingInstruction.java 1030 2022-04-06 13:42:02Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface ProcessingInstruction
extends Element
permits ProcessingInstructionImpl

The definition for a processing instruction.

According to the specification, an XML processing instruction have this general structure

<?name data ?>

with data being arbitrary text as defined by the target processor that responds to the respective processing instruction.

But in many cases, this data will be structured like regular XML attributes.

Therefore we provide both API: with addData(CharSequence) plain text can be added, with the various setAttribute() methods the data will be formatted as attributes.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ProcessingInstruction.java 1030 2022-04-06 13:42:02Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

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

⁠

Method Summary

Modifier and Type	Method	Description
ProcessingInstruction	addData(CharSequence data)	Adds data to the processing instruction.
default ProcessingInstruction	setAttribute(String name, boolean flag)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, double number)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, int number)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, long number)	Sets the attribute with the given name.
default <E extends Enum<E>> ProcessingInstruction	setAttribute(String name, E enumValue)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, Boolean flag)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, CharSequence value)	Sets the attribute with the given name.
ProcessingInstruction	setAttribute(String name, CharSequence value, Optional<? extends CharSequence> append)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, Number number)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, Instant date)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, LocalDate date)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, LocalDateTime date)	Sets the attribute with the given name.
default ProcessingInstruction	setAttribute(String name, ZonedDateTime date)	Sets the attribute with the given name.
default ProcessingInstruction	setAttributeIfNotEmpty(String name, CharSequence value)	Sets the attribute with the given name if the provided value is not empty.
default ProcessingInstruction	setAttributeIfNotEmpty(String name, Optional<? extends CharSequence> optional)	Sets the attribute with the given name if the provided value is not empty.

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

getAttribute, getAttributes, getChildren, getElementName, getNamespaces, getParent, hasChildren, isBlock, setParent, toString

Method Details

addData

ProcessingInstruction addData(CharSequence data)

Adds data to the processing instruction.

Parameters:

data - The data to add.

Returns:

This instance.

setAttribute

default ProcessingInstruction setAttribute(String name,
 boolean flag)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 Boolean flag)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 CharSequence value)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

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

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, the new value will be appended on an already existing one, and this sequence is used as the separator.

Returns:

This instance.

Throws:

IllegalArgumentException - An attribute with the given name is not valid for the element.

setAttribute

default ProcessingInstruction setAttribute(String name,
 double number)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default <E extends Enum<E>> ProcessingInstruction setAttribute(String name,
 E enumValue)
                                                        throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 Instant date)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 int number)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 LocalDate date)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 LocalDateTime date)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 long number)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 Number number)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttribute

default ProcessingInstruction setAttribute(String name,
 ZonedDateTime date)
                                    throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttributeIfNotEmpty

default ProcessingInstruction setAttributeIfNotEmpty(String name,
 CharSequence value)
                                              throws IllegalArgumentException

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, or no attributes are allowed at all.

setAttributeIfNotEmpty

default ProcessingInstruction setAttributeIfNotEmpty(String name,
 Optional<? extends CharSequence> optional)
                                              throws IllegalArgumentException

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, or no attributes are allowed at all.