kiama 0.9.0 API
kiama.parsing.Parsers

class Success
[source: kiama/parsing/Parsers.scala]
case class Success[T](val result : T, val in : scala.util.parsing.input.Reader)
extends ParseResult[T] with scala.Product
A successful parse result.
Parameters
result - a value representing the result of the parse
in - the remainder of the input
Method Summary
def append [U >: T](a : => ParseResult[U]) : ParseResult[U]
If this result reflects a successful parse, return it, otherwise return a.
override def equals (arg0 : Any) : Boolean
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
def flatMapWithNext [U](f : (T) => (scala.util.parsing.input.Reader) => ParseResult[U]) : ParseResult[U]
If this result reflects a successful parse, feed the resulting value and the remainder of the input to f to obtain a final result.
override def hashCode : Int
Returns a hash code value for the object.
def map [U](f : (T) => U) : Success[U]
If this result reflects a successful parse, apply f to the value produced and return the result of that application.
def mapPartial [U](f : scala.PartialFunction[T, U], error : (T) => java.lang.String) : ParseResult[U]
If this result reflects a successful parse, apply the partial function f to the value produced and, if it's defined, return the result of that application. If f is not defined, produce a failure result with the message produced by applying error to the result value.
def position (in : scala.util.parsing.input.Reader) : ParseResult[T]
Set the position of this result to that of in, if it is capable of holding position information and doesn't already have some.
override def productArity : Int
override def productElement (arg0 : Int) : Any
override def productPrefix : java.lang.String
override def toString : java.lang.String
Returns a string representation of the object.
Methods inherited from AnyRef
getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def map[U](f : (T) => U) : Success[U]
If this result reflects a successful parse, apply f to the value produced and return the result of that application.
Overrides
ParseResult.map
def mapPartial[U](f : scala.PartialFunction[T, U], error : (T) => java.lang.String) : ParseResult[U]
If this result reflects a successful parse, apply the partial function f to the value produced and, if it's defined, return the result of that application. If f is not defined, produce a failure result with the message produced by applying error to the result value.
Overrides
ParseResult.mapPartial
def flatMapWithNext[U](f : (T) => (scala.util.parsing.input.Reader) => ParseResult[U]) : ParseResult[U]
If this result reflects a successful parse, feed the resulting value and the remainder of the input to f to obtain a final result.
Overrides
ParseResult.flatMapWithNext
def append[U >: T](a : => ParseResult[U]) : ParseResult[U]
If this result reflects a successful parse, return it, otherwise return a.
Overrides
ParseResult.append
def position(in : scala.util.parsing.input.Reader) : ParseResult[T]
Set the position of this result to that of in, if it is capable of holding position information and doesn't already have some.
Overrides
ParseResult.position
override def toString : java.lang.String
Returns a string representation of the object.

The default representation is platform dependent.

Returns
a string representation of the object.

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
Overrides
scala.Product.scala.Product.productPrefix
override def productArity : Int
Overrides
scala.Product.scala.Product.productArity
override def productElement(arg0 : Int) : Any
Overrides
scala.Product.scala.Product.productElement
kiama 0.9.0 API