mainargs
API
Generated with
mainargs/mainargs/ArgSig

ArgSig

mainargs.ArgSig
See theArgSig companion object
class ArgSig extends Product, Serializable, Equals

Models what is known by the router about a single argument: that it has a longName, a human-readable typeString describing what the type is (just for logging and reading, not a replacement for a TypeTag) and possible a function that can compute its default value

Attributes

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

Members list

Value members

Deprecated constructors

def this(unmappedName: Option[String], shortName: Option[Char], doc: Option[String], default: Option[Any => Any], reader: TokensReader[_], positional: Boolean, hidden: Boolean)

Attributes

Deprecated
true

Concrete methods

override def canEqual(that: Any): Boolean

Attributes

Definition Classes
Equals
override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

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

Calculate a hash code value for the object.

Calculate 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
def longName(nameMapper: String => Option[String]): Option[String]
def mappedName(nameMapper: String => Option[String]): Option[String]
def unMappedName: Option[String]

Deprecated methods

def copy(unMappedName: Option[String], shortName: Option[Char], doc: Option[String], default: Option[Any => Any], reader: TokensReader[_], positional: Boolean, hidden: Boolean): ArgSig

Attributes

Deprecated
true
def name: Option[String]

Attributes

Deprecated
true
def productArity: Int

Attributes

Deprecated
true
def productElement(n: Int): Any

Attributes

Deprecated
true

Inherited methods

def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product

Concrete fields

val argName: Option[String]
val default: Option[Any => Any]
val defaultLongName: Option[String]
val doc: Option[String]
val hidden: Boolean
val positional: Boolean
val shortName: Option[Char]
Generated with