cats-xml
API
Generated with
cats-xml/cats.xml/cats.xml.cursor/AttrCursor

AttrCursor

cats.xml.cursor.AttrCursor
See theAttrCursor companion object
final class AttrCursor(val vCursor: NodeCursor, op: Op) extends HCursor[XmlAttribute, NodeCursor, AttrCursor]

Horizontal cursor for node attributes

Attributes

Companion
object
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited types

override type Focus = HFocus

Attributes

Inherited from:
HCursor

Value members

Concrete methods

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
Any
override def focus(xml: XmlNode): Result[XmlAttribute]

Apply the current cursor to the specified input. This allows to select a precise part of the Xml tree.

Apply the current cursor to the specified input. This allows to select a precise part of the Xml tree.

The method is pure and return a Left when the focusing fails

Value parameters

input

target of the cursor

Attributes

Returns

Right when succeed Left when fail

Definition Classes
override def head: AttrCursor

Attributes

Definition Classes
override def last: AttrCursor

Attributes

Definition Classes
override def left: AttrCursor

Attributes

Definition Classes
override def modify(modifier: () => XmlAttribute): Modifier[XmlNode]

Attributes

Definition Classes
WithModifierSupport
override def modify[T : Decoder, U : DataEncoder](f: T => U): Modifier[XmlNode]

Attributes

Definition Classes
WithDataModifierSupport
override def right: AttrCursor

Attributes

Definition Classes

Inherited methods

def as[T : Decoder]: FreeCursor[T]

Create a FreeCursor which represent a cursor with a free T type as result of the focusing, this implies that a Decoder instance is need to convert the fixed Xml type of the Cursor to the free T type of the FreeCursor.

Create a FreeCursor which represent a cursor with a free T type as result of the focusing, this implies that a Decoder instance is need to convert the fixed Xml type of the Cursor to the free T type of the FreeCursor.

So, practically speaking, when the FreeCursor is applied this Cursor is applied and the result is decoded using the specified Decoder for type T.

Type parameters

T

free type in which decode the current cursor result

Attributes

Returns

A new FreeCursor

Inherited from:
Cursor
def modify[U : DataEncoder](f: String => U): Modifier[XmlNode]

Attributes

Inherited from:
WithDataModifierSupport (hidden)
def set[U : DataEncoder](newValue: U): Modifier[XmlNode]

Attributes

Inherited from:
WithDataModifierSupport (hidden)
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
Cursor -> Any
Inherited from:
Cursor
final def up: VC

Attributes

Inherited from:
HCursor

Concrete fields

lazy val path: String

A String representation of the cursor.

A String representation of the cursor.

Attributes

Returns

a String which represent the cursor path

Generated with