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

XmlNode

cats.xml.XmlNode
See theXmlNode companion object
sealed trait XmlNode extends Xml

Attributes

Companion
object
Graph
Supertypes
trait Xml
class Object
trait Matchable
class Any
Known subtypes
class Group
class Node

Members list

Type members

Types

type Self <: XmlNode

Value members

Abstract methods

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

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

def duplicate: XmlNode

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

def label: String

Get the node label value

Get the node label value

 <Foo></Foo> //foo

Attributes

Returns

node label string

Concrete methods

def children: Seq[XmlNode]
def focus[X <: Xml](f: Root.type => Cursor[X]): Result[X]
Implicitly added by XmlNodeCursorOps

Build and apply a Cursor to this XmlNode instance.

Build and apply a Cursor to this XmlNode instance.

Type parameters

X

type of the focusing output

Value parameters

f

function to build the cursor

Attributes

Returns

Cursor result, Left when fails Right when succeed

def focus[T](f: Root.type => FreeCursor[T]): Result[T]
Implicitly added by XmlNodeCursorOps

Build and apply a FreeCursor to this XmlNode instance.

Build and apply a FreeCursor to this XmlNode instance.

Type parameters

T

type of the focusing output

Value parameters

f

function to build the cursor

Attributes

Returns

Cursor result, Left when fails Right when succeed

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

def hasAllAttributes(value: XmlAttribute => Boolean, values: XmlAttribute => Boolean*): Boolean
def hasAllAttributes(keyValue: (String, String), keyValues: (String, String)*): Boolean
def hasAllAttributesKeys(key: String => Boolean, keys: String => Boolean*): Boolean
def hasAllAttributesKeys(key: String, keys: String*): Boolean
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

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

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

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

def modify(f: Root.type => Modifier[XmlNode]): Result[XmlNode]
Implicitly added by XmlNodeCursorOps
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

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

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 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
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
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

Concrete fields

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 fields

final lazy val isAttribute: Boolean

Attributes

Inherited from:
Xml
final lazy val isData: Boolean

Attributes

Inherited from:
Xml
final lazy val isNode: Boolean

Attributes

Inherited from:
Xml
final lazy val isNull: Boolean

Attributes

Inherited from:
Xml
Generated with