Package ball.xml

Interface FluentNode

All Superinterfaces:

Node

All Known Subinterfaces:

FluentDocument

public interface FluentNode
extends Node

Fluent Node interface Note: This interface is an implementation detail of FluentDocument.Builder and should not be implemented or extended directly.

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FluentNode.InvocationHandler	FluentNode InvocationHandler.

Field Summary

Fields

Modifier and Type	Field	Description
static Map<Short,Class<? extends Node>>	NODE_TYPE_MAP	Map Node.getNodeType() to type (Class).

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Modifier and Type	Method	Description
default FluentNode	add(Stream<Node> stream)	Method to add Nodes to this FluentNode.
default FluentNode	add(Node... nodes)	Method to add Nodes to this FluentNode.
default FluentNode	attr(String name)	Create an Attr Node.
default FluentNode	attr(String name, String value)	Create an Attr Node.
default FluentNode	attrNS(String ns, String qn)	Create an Attr Node.
default FluentNode	attrNS(String ns, String qn, String value)	Create an Attr Node.
default FluentNode	cdata(String data)	Create a CDATASection Node.
default FluentNode	comment(String data)	Create a Comment Node.
default String	content()	See Node.getTextContent().
default FluentNode	content(String content)	See Node.setTextContent(String).
default FluentNode	element(String name, Stream<Node> stream)	Create an Element Node.
default FluentNode	element(String name, Node... nodes)	Create an Element Node.
default FluentNode	elementNS(String ns, String qn, Stream<Node> stream)	Create an Element Node.
default FluentNode	elementNS(String ns, String qn, Node... nodes)	Create an Element Node.
default FluentNode	fragment(Stream<Node> stream)	Create an DocumentFragment Node.
default FluentNode	fragment(Node... nodes)	Create an DocumentFragment Node.
default String	name()	See Node.getNodeName().
default FluentDocument	owner()	See Node.getOwnerDocument().
default FluentNode	text(String content)	Create a Text Node.
default String	value()	See Node.getNodeValue().
default FluentNode	value(String value)	See Node.setNodeValue(String).

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

NODE_TYPE_MAP

static final Map<Short,Class<? extends Node>> NODE_TYPE_MAP

Map Node.getNodeType() to type (Class).

Key	Value
1	Element
2	Attr
3	Text
4	CDATASection
5	EntityReference
6	Entity
7	ProcessingInstruction
8	Comment
9	Document
10	DocumentType
11	DocumentFragment
12	Notation

Method Detail

owner

default FluentDocument owner()

See Node.getOwnerDocument().

Returns:

The owner FluentDocument.

name

default String name()

See Node.getNodeName().

Returns:

Node.getNodeName()

value

default String value()

See Node.getNodeValue().

Returns:

Node.getNodeValue()

value

default FluentNode value(String value)

See Node.setNodeValue(String).

Parameters:

value - The Node value.

Returns:

this

content

default String content()

See Node.getTextContent().

Returns:

Node.getTextContent()

content

default FluentNode content(String content)

See Node.setTextContent(String).

Parameters:

content - The Node content.

Returns:

this

add

default FluentNode add(Stream<Node> stream)

Method to add Nodes to this FluentNode.

Parameters:

stream - The Stream of Nodes to add.

Returns:

this

add

default FluentNode add(Node... nodes)

Method to add Nodes to this FluentNode.

Parameters:

nodes - The Nodes to add.

Returns:

this

fragment

default FluentNode fragment(Stream<Node> stream)

Create an DocumentFragment Node.

Parameters:

stream - The Stream of Nodes to append to the newly created DocumentFragment.

Returns:

The newly created DocumentFragment.

fragment

default FluentNode fragment(Node... nodes)

Create an DocumentFragment Node.

Parameters:

nodes - The Nodes to append to the newly created DocumentFragment.

Returns:

The newly created DocumentFragment.

element

default FluentNode element(String name,
                           Stream<Node> stream)

Create an Element Node.

Parameters:

name - The Element name.

stream - The Stream of Nodes to append to the newly created Element.

Returns:

The newly created Element.

element

default FluentNode element(String name,
                           Node... nodes)

Create an Element Node.

Parameters:

name - The Element name.

nodes - The Nodes to append to the newly created Element.

Returns:

The newly created Element.

elementNS

default FluentNode elementNS(String ns,
                             String qn,
                             Stream<Node> stream)

Create an Element Node.

Parameters:

ns - The Element namespace.

qn - The Element qualified name.

stream - The Stream of Nodes to append to the newly created Element.

Returns:

The newly created Element.

elementNS

default FluentNode elementNS(String ns,
                             String qn,
                             Node... nodes)

Create an Element Node.

Parameters:

ns - The Element namespace.

qn - The Element qualified name.

nodes - The Nodes to append to the newly created Element.

Returns:

The newly created Element.

attr

default FluentNode attr(String name)

Create an Attr Node.

Parameters:

name - The Attr name.

Returns:

The newly created Attr.

attr

default FluentNode attr(String name,
                        String value)

Create an Attr Node.

Parameters:

name - The Attr name.

value - The Attr value.

Returns:

The newly created Attr.

attrNS

default FluentNode attrNS(String ns,
                          String qn)

Create an Attr Node.

Parameters:

ns - The Attr namespace.

qn - The Attr qualified name.

Returns:

The newly created Attr.

attrNS

default FluentNode attrNS(String ns,
                          String qn,
                          String value)

Create an Attr Node.

Parameters:

ns - The Attr namespace.

qn - The Attr qualified name.

value - The Attr value.

Returns:

The newly created Attr.

text

default FluentNode text(String content)

Create a Text Node.

Parameters:

content - The Text content.

Returns:

The newly created Text.

cdata

default FluentNode cdata(String data)

Create a CDATASection Node.

Parameters:

data - The CDATASection data.

Returns:

The newly created CDATASection.

comment

default FluentNode comment(String data)

Create a Comment Node.

Parameters:

data - The Comment data.

Returns:

The newly created Comment.