Scala Library
scala.util.parsing.combinatorold.Parsers

class Success
[source: scala/util/parsing/combinatorold/Parsers.scala]
case class Success[+T](val result : T, val override next : Reader)
extends ParseResult[T] with Product
The success case of ParseResult: contains the result and the remaining input.
Parameters
result - The parser's output
next - The parser's remaining input
Value Summary
val successful : Boolean
Method Summary
override def equals (arg0 : Any) : Boolean
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
def get : T
Returns the embedded result
override def hashCode : Int
Returns a hash code value for the object.
def map [U](f : (T) => U) : Success[U]
Functional composition of ParseResults
def mapPartial [U](f : PartialFunction[T, U], error : (T) => java.lang.String) : ParseResult[U]
Partial functional composition of ParseResults
override def productArity : Int
return k for a product A(x_1,...,x_k)
override def productElement (arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
override def productPrefix : java.lang.String
By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods.
override def toString : java.lang.String
The toString method of a Success
Methods inherited from ParseResult
isEmpty, getOrElse
Methods inherited from AnyRef
getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Value Details
val successful : Boolean
Overrides
ParseResult.successful
Method Details
def map[U](f : (T) => U) : Success[U]
Functional composition of ParseResults
Parameters
`f' - the function to be lifted over this result
Returns
`f' applied to the result of this `ParseResult', packaged up as a new `ParseResult'
Overrides
ParseResult.map
def mapPartial[U](f : PartialFunction[T, U], error : (T) => java.lang.String) : ParseResult[U]
Partial functional composition of ParseResults
Parameters
`f' - the partial function to be lifted over this result
error - a function that takes the same argument as `f' and produces an error message to explain why `f' wasn't applicable (it is called when this is the case)
Returns
if `f' f is defined at the result in this `ParseResult', `f' applied to the result of this `ParseResult', packaged up as a new `ParseResult'. If `f' is not defined, `Failure'.
Overrides
ParseResult.mapPartial
def get : T
Returns the embedded result
Overrides
ParseResult.get
override def toString : java.lang.String
The toString method of a Success
override def hashCode : Int
Returns 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.

Returns
the hash code value for the object.

override def equals(arg0 : Any) : Boolean
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

The default implementations of this method is 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 AnyRef 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 often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

Parameters
arg0 - the object to compare against this object for equality.
Returns
true if the receiver object is equivalent to the argument; false otherwise.

override def productPrefix : java.lang.String
By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods.
Overrides
Product.productPrefix
override def productArity : Int
return k for a product A(x_1,...,x_k)
Overrides
Product.productArity
override def productElement(arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
Parameters
n - the index of the element to return
Throws
IndexOutOfBoundsException -
Returns
The element n elements after the first element
Overrides
Product.productElement
Scala Library