KeyValueTransitionMetadataParser

A TransitionMetadataParser for text in which the TransitionMetadata fields are provided in a key/value format.

The keys are beforeStateKey, afterStateKey, and isDestructiveKey, and they must appear in that order in the parsed text. By default, the keys are case-insensitive; this can be explicitly set using caseSensitiveKeys.

Each key and its value may be separated by an optional token (keyValueSeparator), which may itself be surrounded by zero or more whitespace characters (spaces, tabs, newlines, etc.). The keyValueSeparator defaults to "".

The value for the before state and the after state in the parsed text may contain any non-whitespace characters, and it must be separated from the subsequent text by at least one whitespace character (i.e., the value is "end-delimited" by whitespace). The value for the 'is destructive' flag must be either "true" or "false", and is case-insensitive.

For example: If instantiated with beforeStateKey = "transition-before", afterStateKey = "transition-after", isDestructiveKey = "transition-destructive", and keyValueSeparator = "=", all of the following Strings will parse to a TransitionMetaData with beforeState="1.0.4", afterState="1.0.5", and isDestructive=true:

 "transition-before = 1.0.4 transition-after = 1.0.5 transition-destructive = true"
 "transition-before=1.0.4 ; transition-after=1.0.5 ; transition-destructive=true"
 "Transition-Before = 1.0.4  Transition-After = 1.0.5   Transition-Destructive = True"
 "TRANSITION-BEFORE = 1.0.4 TRANSITION-AFTER = 1.0.5 TRANSITION-DESTRUCTIVE = TRUE"

Since newlines are ignored as whitespace, the following block parsed as a String also returns the same TransitionMetaData as above:

 -- transition-before = 1.0.4
 -- transition-after = 1.0.5
 -- transition-destructive = true

as does this block:

    transition-before =
    1.0.4
    transition-after
      = 1.0.5

    transition-destructive
    =

    true

Author:

Eric Evans

Linear Supertypes

RegexTransitionMetadataParser, TransitionMetadataParser, AnyRef, Any

Instance Constructors

new KeyValueTransitionMetadataParser(beforeStateKey: String, afterStateKey: String, isDestructiveKey: String, keyValueSeparator: String = "", caseSensitiveKeys: Boolean = false)

beforeStateKey
key for the TransitionMetaData beforeState
afterStateKey
key for the TransitionMetaData afterState
isDestructiveKey
key for the TransitionMetaData isDestructive flag
keyValueSeparator
separator between each key and value (defaults to "")
caseSensitiveKeys
set to true if keys should be case-sensitive (defaults to false)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val afterStateKey: String

key for the TransitionMetaData afterState
final def asInstanceOf[T0]: T0

Definition Classes
Any
val beforeStateKey: String

key for the TransitionMetaData beforeState
val caseSensitiveKeys: Boolean

set to true if keys should be case-sensitive (defaults to false)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val isDestructiveKey: String

key for the TransitionMetaData isDestructive flag
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keyValueSeparator: String

separator between each key and value (defaults to "")
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(s: String): Option[TransitionMetaData]

Parse an optional TransitionMetaData instance from the given String.
Parse an optional TransitionMetaData instance from the given String.

Definition Classes
RegexTransitionMetadataParser → TransitionMetadataParser
val regex: Regex

Definition Classes
RegexTransitionMetadataParser
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package parse

class KeyValueTransitionMetadataParser extends RegexTransitionMetadataParser

Author:

Instance Constructors

new KeyValueTransitionMetadataParser(beforeStateKey: String, afterStateKey: String, isDestructiveKey: String, keyValueSeparator: String = "", caseSensitiveKeys: Boolean = false)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val afterStateKey: String

final def asInstanceOf[T0]: T0

val beforeStateKey: String

val caseSensitiveKeys: Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val isDestructiveKey: String

final def isInstanceOf[T0]: Boolean

val keyValueSeparator: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(s: String): Option[TransitionMetaData]

val regex: Regex

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from RegexTransitionMetadataParser

Inherited from TransitionMetadataParser

Inherited from AnyRef

Inherited from Any

Ungrouped