XmlDoc
API
Generated with
XmlDoc/com.phasmidsoftware.xmldoc/com.phasmidsoftware.xmldoc.core

com.phasmidsoftware.xmldoc.core

package com.phasmidsoftware.xmldoc.core

Members list

Type members

Classlikes

case class CDATA(content: String, pre: String, post: String) extends CharSequence, Mergeable[CDATA]

Case class to represent a CDATA node.

Case class to represent a CDATA node.

Value parameters

content

the payload of the CDATA node (will contain , & characters).

post

the postfix (probably a newline).

pre

the prefix (probably a newline).

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Mergeable[CDATA]
trait CharSequence
class Object
trait Matchable
class Any
Show all
object CDATA

Companion object to CDATA.

Companion object to CDATA.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CDATA.type
case class Cartesian(x: Double, y: Double, z: Double)

Represents a point or vector in a three-dimensional Cartesian coordinate system.

Represents a point or vector in a three-dimensional Cartesian coordinate system.

Value parameters

x

The x-coordinate of the Cartesian point.

y

The y-coordinate of the Cartesian point.

z

The z-coordinate of the Cartesian point.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FP

Various utilities for functional programming.

Various utilities for functional programming.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
FP.type
case class FPException(msg: String, eo: Option[Throwable] = ...) extends Exception

This class represents an exception related to functional programming operations.

This class represents an exception related to functional programming operations.

Value parameters

eo

An optional underlying cause for the exception, as a Throwable.

msg

A message describing the exception.

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class LowerCaseInitialRegex(r: String) extends MappableRegex

A specialized regular expression class that extends MappableRegex to provide functionality where the first character of each matched group is converted to lowercase, while the rest of the characters remain unchanged.

A specialized regular expression class that extends MappableRegex to provide functionality where the first character of each matched group is converted to lowercase, while the rest of the characters remain unchanged.

Value parameters

r

The regular expression pattern as a string.

Attributes

Constructor

Creates a LowerCaseInitialRegex instance with a specified regular expression pattern to apply the lowercase transformation to matched groups.

Supertypes
class Regex
trait Serializable
class Object
trait Matchable
class Any
Show all
class MappableRegex(r: String, f: List[String] => List[String]) extends Regex

A class that extends the standard Regex functionality by allowing a transformation to be applied to the sequence of matched groups. This is achieved by providing a function that maps a list of matched groups to a new transformed list.

A class that extends the standard Regex functionality by allowing a transformation to be applied to the sequence of matched groups. This is achieved by providing a function that maps a list of matched groups to a new transformed list.

Value parameters

f

A function that takes a list of matched groups and transforms it into another list.

r

The regular expression pattern as a string.

Attributes

Constructor

Creates a MappableRegex with a given regular expression pattern and a transformation function.

Supertypes
class Regex
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object Mergeable

Companion object for Mergeable.

Companion object for Mergeable.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Mergeable.type
trait Mergeable[T]

Hierarchical trait to satisfy merging.

Hierarchical trait to satisfy merging.

CONSIDER making it a typeclass instead.

Type parameters

T

the underlying type.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CDATA
class Text
class Coordinates
class FeatureData
trait Geometry
class LineString
class LinearRing
class Model
class Point
class Polygon
class GeometryData
class KmlData
class Placemark
class Tessellate
Show all
case class MissingFieldException(message: String, reason: String, cause: Throwable) extends XmlBaseException

Represents an exception thrown when a required field is missing during an XML-related operation.

Represents an exception thrown when a required field is missing during an XML-related operation.

This exception indicates that an expected field was absent, typically during parsing or validation of XML content. It provides additional context regarding the missing field and the reason for its absence through custom error messages.

Value parameters

cause

The underlying throwable that caused this exception, if available.

message

A detailed error message describing the missing field.

reason

A string explaining the reason for the field's absence.

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class PCData(data: String) extends Atom[String]

This class borrowed from Scala XML library as we rely on it but it is no longer used by Scala 3.

This class borrowed from Scala XML library as we rely on it but it is no longer used by Scala 3.

This class (which is not used by all XML parsers, but always used by the XHTML one) represents parseable character data, which appeared as CDATA sections in the input and is to be preserved as CDATA section in the output.

Attributes

Companion
object
Supertypes
class Atom[String]
class SpecialNode
class Node
class NodeSeq
trait Serializable
trait Equality
trait StrictOptimizedSeqOps[Node, Seq, NodeSeq]
trait StrictOptimizedSeqOps[Node, Seq, NodeSeq]
trait StrictOptimizedIterableOps[Node, Seq, NodeSeq]
trait Seq[Node]
trait SeqOps[Node, Seq, NodeSeq]
trait Iterable[Node]
class AbstractSeq[Node]
trait Seq[Node]
trait Pure
trait Equals
trait SeqOps[Node, Seq, NodeSeq]
trait PartialFunction[Int, Node]
trait Int => Node
class AbstractIterable[Node]
trait Iterable[Node]
trait IterableFactoryDefaults[Node, Seq]
trait IterableOps[Node, Seq, NodeSeq]
trait IterableOnceOps[Node, Seq, NodeSeq]
trait IterableOnce[Node]
class Object
trait Matchable
class Any
Show all
object PCData

This singleton object contains the applyand unapply methods for convenient construction and deconstruction. Taken from scala.xml.PCData object.

This singleton object contains the applyand unapply methods for convenient construction and deconstruction. Taken from scala.xml.PCData object.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
PCData.type
object Reflection

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Reflection.type
case class Reflection()

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ReflectionException(str: String, ex: Throwable) extends Exception

A case class representing an exception that occurs during reflection operations.

A case class representing an exception that occurs during reflection operations.

Value parameters

ex

The underlying cause of the exception.

str

The error message associated with the exception.

Attributes

Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object SmartBuffer

Represents a utility class for efficiently building and manipulating strings using a mutable StringBuilder. Provides methods to append strings with optional padding, trim trailing spaces, clear the buffer, and retrieve the current result as a string.

Represents a utility class for efficiently building and manipulating strings using a mutable StringBuilder. Provides methods to append strings with optional padding, trim trailing spaces, clear the buffer, and retrieve the current result as a string.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SmartBuffer(sb: StringBuilder)

A utility class that wraps around a StringBuilder and provides additional functionality such as appending strings with optional padding, trimming trailing spaces, and formatting output. Most of the methods appear to be non-mutating pure functions but, in fact, they all take advantage of the mutable nature of SmartBuffer.

A utility class that wraps around a StringBuilder and provides additional functionality such as appending strings with optional padding, trimming trailing spaces, and formatting output. Most of the methods appear to be non-mutating pure functions but, in fact, they all take advantage of the mutable nature of SmartBuffer.

Value parameters

sb

the underlying StringBuilder instance.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TagProperties

Object TagProperties provides functionality to manage and query a collection of tags that must match a specified condition.

Object TagProperties provides functionality to manage and query a collection of tags that must match a specified condition.

This object allows adding tags to an internal collection and checking whether a given tag exists within that collection.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Text extends Extractors

Companion object for the Text case class. Provides extractor utilities for Text and Option[Text].

Companion object for the Text case class. Provides extractor utilities for Text and Option[Text].

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Extractors
class Object
trait Matchable
class Any
Show all
Self type
Text.type
case class Text($: CharSequence) extends Mergeable[Text]

Represents a text element that wraps a CharSequence and provides functionality for merging text and matching content.

Represents a text element that wraps a CharSequence and provides functionality for merging text and matching content.

Value parameters

$

the wrapped CharSequence representing the text content.

Attributes

Constructor

Creates a new Text instance.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Mergeable[Text]
class Object
trait Matchable
class Any
Show all
object TryUsing

The TryUsing object provides utility methods to manage resources safely and effectively using Scala's Using and Try. It encapsulates resource management in a functional way, ensuring proper release of resources. The methods in this object extend the functionality of Using.apply by offering flattening operations over nested Try.

The TryUsing object provides utility methods to manage resources safely and effectively using Scala's Using and Try. It encapsulates resource management in a functional way, ensuring proper release of resources. The methods in this object extend the functionality of Using.apply by offering flattening operations over nested Try.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
TryUsing.type
object Utilities

Object containing various utility methods for sequence filtering, XML parsing, and rendering XML nodes as strings. CONSIDER splitting this object among FP and XML.

Object containing various utility methods for sequence filtering, XML parsing, and rendering XML nodes as strings. CONSIDER splitting this object among FP and XML.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Utilities.type
object XML

The XML object does nothing other than give a name to this module.

The XML object does nothing other than give a name to this module.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
XML.type
class XmlBaseException(message: String, cause: Throwable) extends Exception

A base exception class for handling XML-related errors.

A base exception class for handling XML-related errors.

This class serves as a parent exception for all XML-specific exceptions, allowing developers to catch and manage errors pertaining to XML processing. It extends the standard Exception class in Scala to provide additional context for XML-related errors through custom messages and causes.

Value parameters

cause

The underlying throwable that triggered this exception, if available.

message

A detailed error message describing the cause of the exception.

Attributes

Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class XmlException
object XmlException

Companion object for the XmlException case class. Provides a utility method to create an instance of XmlException.

Companion object for the XmlException case class. Provides a utility method to create an instance of XmlException.

The apply method creates an XmlException with the specified message, and optionally allows the cause to be set to null by default.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class XmlException(message: String, cause: Throwable) extends XmlBaseException

CONSIDER renaming as ExtractorException.

CONSIDER renaming as ExtractorException.

Value parameters

cause

the cause (or null).

message

the message.

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Generated with