JsonPointer

io.vertx.lang.scala.json.JsonPointer
See theJsonPointer companion class
object JsonPointer

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

Attributes

Returns

an empty JsonPointer

def apply(pointer: String): JsonPointer

Builds a JsonPointer from a String.

Builds a JsonPointer from a String.

Value parameters

pointer

the String representing a valid JSON pointer

Attributes

Returns

the JsonPointer

Throws
IllegalArgumentException

if the given String is not a valid JSON pointer

def apply(pointer: URI): JsonPointer

Builds a JsonPointer from a java.net.URI.

Builds a JsonPointer from a java.net.URI.

Value parameters

pointer
  • the URI representing a valid JSON pointer

Attributes

Returns

the JsonPointer

Throws
IllegalArgumentException

if the given URI is not a valid JSON pointer

Same as apply(), for compatibility with Vert.x core.

Same as apply(), for compatibility with Vert.x core.

Attributes

def from(pointer: String): JsonPointer

Same as apply(pointer), for compatibility with Vert.x core.

Same as apply(pointer), for compatibility with Vert.x core.

Attributes

See also
def fromOption(pointer: String): Option[JsonPointer]

Builds a JsonPointer from a String, returning an Option. This comes in handy in situations when it is unknown if the String contains a valid JSON pointer, e.g. if the String is a variable.

Builds a JsonPointer from a String, returning an Option. This comes in handy in situations when it is unknown if the String contains a valid JSON pointer, e.g. if the String is a variable.

Value parameters

pointer

the String representing a pointer

Attributes

Returns

Some(JsonPointer) if the given String was valid, else None

def fromURIOption(uri: URI): Option[JsonPointer]

Builds a JsonPointer from a URI, returning an Option. This comes in handy in situations when it is unknown if the URI contains a valid JSON pointer, e.g. if the URI is a variable.

Builds a JsonPointer from a URI, returning an Option. This comes in handy in situations when it is unknown if the URI contains a valid JSON pointer, e.g. if the URI is a variable.

Value parameters

uri

the uri representing the JSON pointer

Attributes

Returns

Some(JsonPointer) if the given URI was valid, else None