Args
API
Generated with
Args/com.phasmidsoftware/com.phasmidsoftware.args/OptionalElement

OptionalElement

com.phasmidsoftware.args.OptionalElement
case class OptionalElement(element: Element) extends Element

This represents an optional synopsis element, either an optional flag, or an optional value.

Value parameters

element

a synopsis element that is optional

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Element
trait Ordered[Element]
trait Comparable[Element]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def equals(obj: Any): Boolean

Checks whether this instance is equal to that. This universal equality method is defined in AnyRef.

Checks whether this instance is equal to that. This universal equality method is defined in AnyRef.

Attributes

Definition Classes
Equals -> Any
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def isOptional: Boolean

Method to determine if this Element is optional.

Method to determine if this Element is optional.

Attributes

Returns

true if this Element is optional.

Definition Classes
def value: String

Method to yield the value (name) of this Element

Method to yield the value (name) of this Element

Attributes

Returns

the value/name

Inherited methods

def <(that: Element): Boolean

Returns true if this is less than that

Returns true if this is less than that

Value parameters

that

the instance to compare against

Attributes

Inherited from:
Ordered
def <=(that: Element): Boolean

Returns true if this is less than or equal to that.

Returns true if this is less than or equal to that.

Attributes

Inherited from:
Ordered
def >(that: Element): Boolean

Returns true if this is greater than that.

Returns true if this is greater than that.

Value parameters

that

the instance to compare against

Attributes

Inherited from:
Ordered
def >=(that: Element): Boolean

Returns true if this is greater than or equal to that.

Returns true if this is greater than or equal to that.

Attributes

Inherited from:
Ordered
def asOperand: Option[String]

Method to yield an optional String according as whether this Element is an operand.

Method to yield an optional String according as whether this Element is an operand.

Attributes

Returns

optionally the value of this Operand element (includes optional elements); None if this Element is not an operand.

Inherited from:
Element
def compare(that: Element): Int

Method to compare this Element with that Element.

Method to compare this Element with that Element.

Value parameters

that

the comparand.

Attributes

Returns

the result of invoking value compare that.value

Inherited from:
Element
def compareTo(that: Element): Int

Result of comparing this with operand that.

Result of comparing this with operand that.

Value parameters

that

the instance to compare against

Attributes

Inherited from:
Ordered
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Generated with