scala-xml/scala.xml/MetaData

MetaData

abstract class MetaData extends AbstractIterable[MetaData] with Iterable[MetaData] with Equality with Serializable

This class represents an attribute and at the same time a linked list of attributes. Every instance of this class is either

This class represents an attribute and at the same time a linked list of attributes. Every instance of this class is either

  • an instance of UnprefixedAttribute key,value or
  • an instance of PrefixedAttribute namespace_prefix,key,value or
  • `Null, the empty attribute list.

Namespace URIs are obtained by using the namespace scope of the element owning this attribute (see getNamespace).

Companion
object
trait Serializable
trait Equality
trait Equals
class AbstractIterable[MetaData]
trait Iterable[MetaData]
trait IterableFactoryDefaults[MetaData, [A] =>> Iterable[A]]
trait IterableOps[MetaData, [A] =>> Iterable[A], Iterable[MetaData]]
trait IterableOnceOps[MetaData, [A] =>> Iterable[A], Iterable[MetaData]]
trait IterableOnce[MetaData]
class Object
trait Matchable
class Any
trait Attribute
object Null

Value members

Abstract methods

def apply(key: String): Seq[Node]

Gets value of unqualified (unprefixed) attribute with given key, null if not found

Gets value of unqualified (unprefixed) attribute with given key, null if not found

Returns

value as Seq[Node] if key is found, null otherwise

def apply(namespace_uri: String, scp: NamespaceBinding, k: String): Seq[Node]

Gets value of prefixed attribute with given key and namespace, null if not found

Gets value of prefixed attribute with given key and namespace, null if not found

Value Params
k

to be looked for

namespace_uri

namespace uri of key

scp

a namespace scp (usually of the element owning this attribute list)

Returns

value as Seq[Node] if key is found, null otherwise

def copy(next: MetaData): MetaData

returns a copy of this MetaData item with next field set to argument.

returns a copy of this MetaData item with next field set to argument.

def getNamespace(owner: Node): String

if owner is the element of this metadata item, returns namespace

if owner is the element of this metadata item, returns namespace

def isPrefixed: Boolean
def key: String

returns key of this MetaData item

returns key of this MetaData item

def next: MetaData

returns Null or the next MetaData item

returns Null or the next MetaData item

def remove(key: String): MetaData
def remove(namespace: String, scope: NamespaceBinding, key: String): MetaData
def value: Seq[Node]

returns value of this MetaData item

returns value of this MetaData item

def wellformed(scope: NamespaceBinding): Boolean

Concrete methods

def append(updates: MetaData, scope: NamespaceBinding): MetaData

Updates this MetaData with the MetaData given as argument. All attributes that occur in updates are part of the resulting MetaData. If an attribute occurs in both this instance and updates, only the one in updates is part of the result (avoiding duplicates). For prefixed attributes, namespaces are resolved using the given scope, which defaults to TopScope.

Updates this MetaData with the MetaData given as argument. All attributes that occur in updates are part of the resulting MetaData. If an attribute occurs in both this instance and updates, only the one in updates is part of the result (avoiding duplicates). For prefixed attributes, namespaces are resolved using the given scope, which defaults to TopScope.

Value Params
updates

MetaData with new and updated attributes

Returns

a new MetaData instance that contains old, new and updated attributes

final def apply(namespace_uri: String, owner: Node, key: String): Seq[Node]

convenience method, same as apply(namespace, owner.scope, key).

convenience method, same as apply(namespace, owner.scope, key).

Value Params
key

the attribute key

namespace_uri

namespace uri of key

owner

the element owning this attribute list

def asAttrMap: Map[String, String]

Returns a Map containing the attributes stored as key/value pairs.

Returns a Map containing the attributes stored as key/value pairs.

def buildString(sb: StringBuilder): StringBuilder
override def canEqual(other: Any): Boolean
Definition Classes
Equality -> Equals
override def filter(f: MetaData => Boolean): MetaData

filters this sequence of meta data

filters this sequence of meta data

Definition Classes
IterableOps -> IterableOnceOps
final def get(key: String): Option[Seq[Node]]

Gets value of unqualified (unprefixed) attribute with given key, None if not found

Gets value of unqualified (unprefixed) attribute with given key, None if not found

Returns

value in Some(Seq[Node]) if key is found, None otherwise

final def get(uri: String, owner: Node, key: String): Option[Seq[Node]]

same as get(uri, owner.scope, key)

same as get(uri, owner.scope, key)

final def get(uri: String, scope: NamespaceBinding, key: String): Option[Seq[Node]]

gets value of qualified (prefixed) attribute with given key.

gets value of qualified (prefixed) attribute with given key.

Value Params
key

to be looked fore

scope

a namespace scp (usually of the element owning this attribute list)

uri

namespace of key

Returns

value as Some[Seq[Node]] if key is found, None otherwise

def hasNext: Boolean
def length: Int
def length(i: Int): Int
def prefixedKey: String

Returns a String containing "prefix:key" if the first key is prefixed, and "key" otherwise.

Returns a String containing "prefix:key" if the first key is prefixed, and "key" otherwise.

final def remove(namespace: String, owner: Node, key: String): MetaData
override def strict_==(other: Equality): Boolean
Definition Classes
override def toString(): String
Definition Classes
Iterable -> Any

Inherited methods

@inline
final def ++[B >: MetaData](suffix: IterableOnce[B]): Iterable[B]
Inherited from
IterableOps
@inline
final def addString(b: StringBuilder): StringBuilder
Inherited from
IterableOnceOps
@inline
final def addString(b: StringBuilder, sep: String): StringBuilder
Inherited from
IterableOnceOps
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
Inherited from
IterableOnceOps
def collect[B](pf: PartialFunction[MetaData, B]): Iterable[B]
Inherited from
IterableOps
def collectFirst[B](pf: PartialFunction[MetaData, B]): Option[B]
Inherited from
IterableOnceOps
def concat[B >: MetaData](suffix: IterableOnce[B]): Iterable[B]
Inherited from
IterableOps
def copyToArray[B >: MetaData](xs: Array[B], start: Int, len: Int): Int
Inherited from
IterableOnceOps
@deprecatedOverriding("This should always forward to the 3-arg version of this method", "2.13.4")
def copyToArray[B >: MetaData](xs: Array[B], start: Int): Int
Inherited from
IterableOnceOps
@deprecatedOverriding("This should always forward to the 3-arg version of this method", "2.13.4")
def copyToArray[B >: MetaData](xs: Array[B]): Int
Inherited from
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: (MetaData, B) => Boolean): Boolean
Inherited from
IterableOnceOps
def count(p: MetaData => Boolean): Int
Inherited from
IterableOnceOps
def drop(n: Int): Iterable[MetaData]
Inherited from
IterableOps
def dropRight(n: Int): Iterable[MetaData]
Inherited from
IterableOps
def dropWhile(p: MetaData => Boolean): Iterable[MetaData]
Inherited from
IterableOps
override def empty: Iterable[MetaData]
Definition Classes
IterableFactoryDefaults -> IterableOps
Inherited from
IterableFactoryDefaults
override def equals(other: Any): Boolean
Definition Classes
Equality -> Equals -> Any
Inherited from
Equality
def exists(p: MetaData => Boolean): Boolean
Inherited from
IterableOnceOps
def filterNot(pred: MetaData => Boolean): Iterable[MetaData]
Inherited from
IterableOps
def find(p: MetaData => Boolean): Option[MetaData]
Inherited from
IterableOnceOps
def flatMap[B](f: MetaData => IterableOnce[B]): Iterable[B]
Inherited from
IterableOps
def flatten[B](asIterable: MetaData => IterableOnce[B]): Iterable[B]
Inherited from
IterableOps
def fold[A1 >: MetaData](z: A1)(op: (A1, A1) => A1): A1
Inherited from
IterableOnceOps
def foldLeft[B](z: B)(op: (B, MetaData) => B): B
Inherited from
IterableOnceOps
def foldRight[B](z: B)(op: (MetaData, B) => B): B
Inherited from
IterableOnceOps
def forall(p: MetaData => Boolean): Boolean
Inherited from
IterableOnceOps
def foreach[U](f: MetaData => U): Unit
Inherited from
IterableOnceOps
protected def fromSpecific(coll: IterableOnce[MetaData]): Iterable[MetaData]
Inherited from
IterableFactoryDefaults
def groupBy[K](f: MetaData => K): Map[K, Iterable[MetaData]]
Inherited from
IterableOps
def groupMap[K, B](key: MetaData => K)(f: MetaData => B): Map[K, Iterable[B]]
Inherited from
IterableOps
def groupMapReduce[K, B](key: MetaData => K)(f: MetaData => B)(reduce: (B, B) => B): Map[K, B]
Inherited from
IterableOps
def grouped(size: Int): Iterator[Iterable[MetaData]]
Inherited from
IterableOps
override def hashCode(): Int

It's be nice to make these final, but there are probably people out there subclassing the XML types, especially when it comes to equals. However WE at least can pretend they are final since clearly individual classes cannot be trusted to maintain a semblance of order.

It's be nice to make these final, but there are probably people out there subclassing the XML types, especially when it comes to equals. However WE at least can pretend they are final since clearly individual classes cannot be trusted to maintain a semblance of order.

Definition Classes
Equality -> Any
Inherited from
Equality
def head: MetaData
Inherited from
IterableOps
def headOption: Option[MetaData]
Inherited from
IterableOps
def init: Iterable[MetaData]
Inherited from
IterableOps
def inits: Iterator[Iterable[MetaData]]
Inherited from
IterableOps
def isEmpty: Boolean
Inherited from
IterableOnceOps
override def isTraversableAgain: Boolean
Definition Classes
IterableOps -> IterableOnceOps
Inherited from
IterableOps
def iterableFactory: IterableFactory[[A] =>> Iterable[A]]
Inherited from
Iterable
def iterator: Iterator[MetaData]
Inherited from
IterableOnce
def knownSize: Int
Inherited from
IterableOnce
def last: MetaData
Inherited from
IterableOps
def lastOption: Option[MetaData]
Inherited from
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[MetaData, B, MetaData]
Inherited from
Iterable
def map[B](f: MetaData => B): Iterable[B]
Inherited from
IterableOps
def max[B >: MetaData](ord: Ordering[B]): MetaData
Inherited from
IterableOnceOps
def maxBy[B](f: MetaData => B)(cmp: Ordering[B]): MetaData
Inherited from
IterableOnceOps
def maxByOption[B](f: MetaData => B)(cmp: Ordering[B]): Option[MetaData]
Inherited from
IterableOnceOps
def maxOption[B >: MetaData](ord: Ordering[B]): Option[MetaData]
Inherited from
IterableOnceOps
def min[B >: MetaData](ord: Ordering[B]): MetaData
Inherited from
IterableOnceOps
def minBy[B](f: MetaData => B)(cmp: Ordering[B]): MetaData
Inherited from
IterableOnceOps
def minByOption[B](f: MetaData => B)(cmp: Ordering[B]): Option[MetaData]
Inherited from
IterableOnceOps
def minOption[B >: MetaData](ord: Ordering[B]): Option[MetaData]
Inherited from
IterableOnceOps
@inline
final def mkString: String
Inherited from
IterableOnceOps
@inline
final def mkString(sep: String): String
Inherited from
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String
Inherited from
IterableOnceOps
protected def newSpecificBuilder: Builder[MetaData, Iterable[MetaData]]
Inherited from
IterableFactoryDefaults
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")
def nonEmpty: Boolean
Inherited from
IterableOnceOps
def partition(p: MetaData => Boolean): (Iterable[MetaData], Iterable[MetaData])
Inherited from
IterableOps
def partitionMap[A1, A2](f: MetaData => Either[A1, A2]): (Iterable[A1], Iterable[A2])
Inherited from
IterableOps
def product[B >: MetaData](num: Numeric[B]): B
Inherited from
IterableOnceOps
def reduce[B >: MetaData](op: (B, B) => B): B
Inherited from
IterableOnceOps
def reduceLeft[B >: MetaData](op: (B, MetaData) => B): B
Inherited from
IterableOnceOps
def reduceLeftOption[B >: MetaData](op: (B, MetaData) => B): Option[B]
Inherited from
IterableOnceOps
def reduceOption[B >: MetaData](op: (B, B) => B): Option[B]
Inherited from
IterableOnceOps
def reduceRight[B >: MetaData](op: (MetaData, B) => B): B
Inherited from
IterableOnceOps
def reduceRightOption[B >: MetaData](op: (MetaData, B) => B): Option[B]
Inherited from
IterableOnceOps
protected def reversed: Iterable[MetaData]
Inherited from
IterableOnceOps
def scan[B >: MetaData](z: B)(op: (B, B) => B): Iterable[B]
Inherited from
IterableOps
def scanLeft[B](z: B)(op: (B, MetaData) => B): Iterable[B]
Inherited from
IterableOps
def scanRight[B](z: B)(op: (MetaData, B) => B): Iterable[B]
Inherited from
IterableOps
def size: Int
Inherited from
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int
Inherited from
IterableOps
def sizeCompare(otherSize: Int): Int
Inherited from
IterableOps
@inline
final def sizeIs: SizeCompareOps
Inherited from
IterableOps
def slice(from: Int, until: Int): Iterable[MetaData]
Inherited from
IterableOps
def sliding(size: Int, step: Int): Iterator[Iterable[MetaData]]
Inherited from
IterableOps
def sliding(size: Int): Iterator[Iterable[MetaData]]
Inherited from
IterableOps
def span(p: MetaData => Boolean): (Iterable[MetaData], Iterable[MetaData])
Inherited from
IterableOps
override def splitAt(n: Int): (Iterable[MetaData], Iterable[MetaData])
Definition Classes
IterableOps -> IterableOnceOps
Inherited from
IterableOps
def stepper[S <: Stepper[_]](shape: StepperShape[MetaData, S]): S
Inherited from
IterableOnce
def strict_!=(other: Equality): Boolean
Inherited from
Equality
def sum[B >: MetaData](num: Numeric[B]): B
Inherited from
IterableOnceOps
def tail: Iterable[MetaData]
Inherited from
IterableOps
def tails: Iterator[Iterable[MetaData]]
Inherited from
IterableOps
def take(n: Int): Iterable[MetaData]
Inherited from
IterableOps
def takeRight(n: Int): Iterable[MetaData]
Inherited from
IterableOps
def takeWhile(p: MetaData => Boolean): Iterable[MetaData]
Inherited from
IterableOps
override def tapEach[U](f: MetaData => U): Iterable[MetaData]
Definition Classes
IterableOps -> IterableOnceOps
Inherited from
IterableOps
def to[C1](factory: Factory[MetaData, C1]): C1
Inherited from
IterableOnceOps
def toArray[B >: MetaData](ClassTag[B]): Array[B]
Inherited from
IterableOnceOps
@inline
final def toBuffer[B >: MetaData]: Buffer[B]
Inherited from
IterableOnceOps
def toIndexedSeq: IndexedSeq[MetaData]
Inherited from
IterableOnceOps
final def toIterable: MetaData
Inherited from
Iterable
def toList: List[MetaData]
Inherited from
IterableOnceOps
def toMap[K, V](ev: MetaData <:< (K, V)): Map[K, V]
Inherited from
IterableOnceOps
def toSeq: Seq[MetaData]
Inherited from
IterableOnceOps
def toSet[B >: MetaData]: Set[B]
Inherited from
IterableOnceOps
def toVector: Vector[MetaData]
Inherited from
IterableOnceOps
def transpose[B](asIterable: MetaData => Iterable[B]): Iterable[Iterable[B]]
Inherited from
IterableOps
def unzip[A1, A2](asPair: MetaData => (A1, A2)): (Iterable[A1], Iterable[A2])
Inherited from
IterableOps
def unzip3[A1, A2, A3](asTriple: MetaData => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])
Inherited from
IterableOps
def view: View[MetaData]
Inherited from
IterableOps
def withFilter(p: MetaData => Boolean): WithFilter[MetaData, [A] =>> Iterable[A]]
Inherited from
IterableOps
final def xml_!=(other: Any): Boolean
Inherited from
Equality
final def xml_==(other: Any): Boolean
Inherited from
Equality
def zip[B](that: IterableOnce[B]): Iterable[(MetaData, B)]
Inherited from
IterableOps
def zipAll[A1 >: MetaData, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]
Inherited from
IterableOps
def zipWithIndex: Iterable[(MetaData, Int)]
Inherited from
IterableOps

Deprecated and Inherited methods

@deprecated("Use ++ instead of ++: for collections of type Iterable", "2.13.0")
def ++:[B >: MetaData](that: IterableOnce[B]): Iterable[B]
Deprecated
Inherited from
IterableOps
@inline @deprecated("Use foldLeft instead of /:", "2.13.0")
final def /:[B](z: B)(op: (B, MetaData) => B): B
Deprecated
Inherited from
IterableOnceOps
@inline @deprecated("Use foldRight instead of :\\", "2.13.0")
final def :\[B](z: B)(op: (MetaData, B) => B): B
Deprecated
Inherited from
IterableOnceOps
@deprecated("`aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.", "2.13.0")
def aggregate[B](z: => B)(seqop: (B, MetaData) => B, combop: (B, B) => B): B
Deprecated
Inherited from
IterableOnceOps
@inline @deprecatedOverriding("Use iterableFactory instead", "2.13.0") @deprecated("Use iterableFactory instead", "2.13.0")
def companion: IterableFactory[[A] =>> Iterable[A]]
Deprecated
Inherited from
IterableOps
@inline @deprecated("Use `dest ++= coll` instead", "2.13.0")
final def copyToBuffer[B >: MetaData](dest: Buffer[B]): Unit
Deprecated
Inherited from
IterableOnceOps
@deprecated("Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)", "2.13.0")
def hasDefiniteSize: Boolean
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use coll instead of repr in a collection implementation, use the collection value itself from the outside", "2.13.0")
final def repr: Iterable[MetaData]
Deprecated
Inherited from
IterableOps
@deprecated("Iterable.seq always returns the iterable itself", "2.13.0")
def seq: MetaData
Deprecated
Inherited from
Iterable
@inline @deprecated("Use .iterator instead of .toIterator", "2.13.0")
final def toIterator: Iterator[MetaData]
Deprecated
Inherited from
IterableOnceOps
@inline @deprecated("Use .to(LazyList) instead of .toStream", "2.13.0")
final def toStream: Stream[MetaData]
Deprecated
Inherited from
IterableOnceOps
@deprecated("Use toIterable instead", "2.13.0")
final def toTraversable: Iterable[MetaData]
Deprecated
Inherited from
IterableOps
@deprecated("Use .view.slice(from, until) instead of .view(from, until)", "2.13.0")
def view(from: Int, until: Int): View[MetaData]
Deprecated
Inherited from
IterableOps