cats-xml
API
Generated with
cats-xml/cats.xml/XmlNode/Node

Node

cats.xml.XmlNode.Node
final class Node extends XmlNode

Represent a simple single XML node.

<Bar>
 <Foo a="1">
 <Foo a="2">
 <Foo a="3">
</Bar>

Attributes

Graph
Supertypes
trait XmlNode
trait Xml
class Object
trait Matchable
class Any

Members list

Type members

Types

override type Self = Node

Value members

Concrete methods

def appendAttr(newAttr: XmlAttribute): Node
Implicitly added by XmlNodeNodeWriteOps
def appendAttrs(newAttr: XmlAttribute, newAttrs: XmlAttribute*): Node
Implicitly added by XmlNodeNodeWriteOps
def appendAttrs(newAttrs: Seq[XmlAttribute]): Node
Implicitly added by XmlNodeNodeWriteOps
override def attributes: List[XmlAttribute]

Get the node label value

Get the node label value

 <Foo a="1" b="2" ></Foo> //a="1" b="2"

Attributes

Returns

list of node attributes

Definition Classes
override def content: NodeContent

Return the node content which can be:

Return the node content which can be:

If you need a specific kind of content please use either XmlNode.text, XmlNode.isEmpty or XmlNode.children instead

Attributes

Returns

Node content instance

Definition Classes
override def duplicate: Node

Create a new immutable instance with the same values of the current one

Create a new immutable instance with the same values of the current one

Attributes

Returns

A new instance with the same values of the current one

Definition Classes
override def label: String

Get the node label value

Get the node label value

 <Foo></Foo> //foo

Attributes

Returns

node label string

Definition Classes
def prependAttr(newAttr: XmlAttribute): Node
Implicitly added by XmlNodeNodeWriteOps
def prependAttrs(newAttr: XmlAttribute, newAttrs: XmlAttribute*): Node
Implicitly added by XmlNodeNodeWriteOps
def prependAttrs(newAttrs: Seq[XmlAttribute]): Node
Implicitly added by XmlNodeNodeWriteOps
def removeAttr(key: String): Node
Implicitly added by XmlNodeNodeWriteOps
def updateAttr(key: String)(f: () => XmlAttribute): Node
Implicitly added by XmlNodeNodeWriteOps
def updateText[T : DataEncoder](f: () => T)(implicit evidence$1: Decoder[T], evidence$2: DataEncoder[T], dmi: DummyImplicit): Node
Implicitly added by XmlNodeNodeWriteOps

Decode and then update node text if content is text.

Decode and then update node text if content is text.

If you need raw data see updateTextRaw

Attributes

def updateText[T1 : Decoder, T2 : DataEncoder](f: T1 => T2): Node
Implicitly added by XmlNodeNodeWriteOps

Decode and then update node text if content is text.

Decode and then update node text if content is text.

If you need raw data see updateTextRaw

Attributes

def updateTextRaw[T : DataEncoder](f: XmlData => T): Node
Implicitly added by XmlNodeNodeWriteOps

Update node text if content is text.

Update node text if content is text.

If you need decoded data see updateText

Attributes

def withAttrs(attrs: Seq[XmlAttribute]): Node
Implicitly added by XmlNodeNodeWriteOps
def withAttrs(attr: XmlAttribute, attrs: XmlAttribute*): Node
Implicitly added by XmlNodeNodeWriteOps
def withAttrsMap(attrs: (String, String)*): Node
Implicitly added by XmlNodeNodeWriteOps
def withAttrsMap(attrs: Map[String, String]): Node
Implicitly added by XmlNodeNodeWriteOps
def withLabel(newLabel: String): Node
Implicitly added by XmlNodeNodeWriteOps

Rename node label. This method isn't pure for usability purpose.

Rename node label. This method isn't pure for usability purpose.

Throws IllegalArgumentException If the new label values is not valid. See Xml.isValidXmlName

Value parameters

newLabel

new label value

Attributes

Returns

Same node with updated label

def withText[T : DataEncoder](data: T): Node
Implicitly added by XmlNodeNodeWriteOps

Set node content to Text with the specified data. All children nodes will be removed.

Set node content to Text with the specified data. All children nodes will be removed.

Attributes

Deprecated methods

def withAttributes(attrs: Seq[XmlAttribute]): Node
Implicitly added by XmlNodeNodeWriteOps

Attributes

Deprecated
[Since version 0.0.14] Use withAttrs instead. This method will be removed in the future versions.
def withAttributes(attr: XmlAttribute, attrs: XmlAttribute*): Node
Implicitly added by XmlNodeNodeWriteOps

Attributes

Deprecated
[Since version 0.0.14] Use withAttrs instead. This method will be removed in the future versions.

Inherited methods

final def asAttribute: Option[XmlAttribute]

Attributes

Inherited from:
Xml
final def asData: Option[XmlData]

Attributes

Inherited from:
Xml
final def asGroup: Option[Group]

Attributes

Inherited from:
Xml
final def asNode: Option[Node]

Attributes

Inherited from:
Xml
def children: Seq[XmlNode]

Attributes

Inherited from:
XmlNode
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Xml -> Any
Inherited from:
Xml
def fold[T](ifNode: Node => T, ifGroup: Group => T): T

Type parameters

T

result type parameter

Value parameters

ifGroup

Function invoked when the current node is of type Group

ifNode

Function invoked when the current node is of type Node

Attributes

Returns

T value

Inherited from:
XmlNode
def hasAllAttributes(keyValue: (String, String), keyValues: (String, String)*): Boolean

Attributes

Inherited from:
XmlNode
def hasAllAttributes(value: XmlAttribute => Boolean, values: XmlAttribute => Boolean*): Boolean

Attributes

Inherited from:
XmlNode
def hasAllAttributesKeys(key: String, keys: String*): Boolean

Attributes

Inherited from:
XmlNode
def hasAllAttributesKeys(key: String => Boolean, keys: String => Boolean*): Boolean

Attributes

Inherited from:
XmlNode
def hasChild(label: String, predicate: XmlNode => Boolean): Boolean

Check if the node has a child with the specified label which satisfies the specified predicate.

Check if the node has a child with the specified label which satisfies the specified predicate.

Attributes

Returns

true if the node has a child with specified label which satisfies the predicate, false otherwise

Inherited from:
XmlNode
def hasChildren: Boolean

Check if the node has children

Check if the node has children

Attributes

Returns

true if the node has children, false otherwise

Inherited from:
XmlNode
def hasText: Boolean

Check is the node has text

Check is the node has text

Attributes

Returns

true if the node has text content, false otherwise. Always false if node is XmlNode.Group

Inherited from:
XmlNode
def isEmpty: Boolean

Check if the node has empty content

Check if the node has empty content

Attributes

Returns

true if node content is empty, false otherwise

Inherited from:
XmlNode
def text: Option[XmlData]

Get node text data

Get node text data

Attributes

Returns

Node text if the content contains text. Always None if node is XmlNode.Group

Inherited from:
XmlNode
def textString: String

Get node text as string

Get node text as string

Attributes

Returns

Node text if the content contains text. Always None if node is XmlNode.Group

Inherited from:
XmlNode
final def toGroup: Group

Convert the node to a group. If this instance already is a group it will be returned the same instance.

Convert the node to a group. If this instance already is a group it will be returned the same instance.

Attributes

Inherited from:
XmlNode
final override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Xml -> Any
Inherited from:
Xml
def unsafeNarrowGroup: Group

Attributes

Inherited from:
XmlNode
def unsafeNarrowNode: Node

Attributes

Inherited from:
XmlNode

Inherited fields

final lazy val isAttribute: Boolean

Attributes

Inherited from:
Xml
final lazy val isData: Boolean

Attributes

Inherited from:
Xml
lazy val isGroup: Boolean

Check if the node is a group

Check if the node is a group

Attributes

Returns

true if node is a group, false otherwise

Inherited from:
XmlNode
final lazy val isNode: Boolean

Attributes

Inherited from:
Xml
final lazy val isNull: Boolean

Attributes

Inherited from:
Xml
Generated with