scala.util.parsing.combinator.Parsers

Failure

case class Failure (msg: String, next: Input) extends NoSuccess with Product

The failure case of ParseResult: contains an error-message and the remaining input. Parsing will back-track when a failure occurs.

msg

An error message string describing the failure.

next

The parser's unconsumed input at the point where the failure occurred.

linear super types: Product, Equals, NoSuccess, ParseResult[Nothing], AnyRef, Any
source: Parsers.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Failure
  2. Product
  3. Equals
  4. NoSuccess
  5. ParseResult
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new Failure (msg: String, next: Input)

    msg

    An error message string describing the failure.

    next

    The parser's unconsumed input at the point where the failure occurred.

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

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

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  7. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  8. def append [U] (a: ⇒ ParseResult[U]) : ParseResult[U]

    definition classes: FailureParseResult
  9. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def canEqual (arg0: Any) : Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    definition classes: FailureEquals
  11. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected[lang]
    definition classes: AnyRef
  12. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  13. def equals (arg0: Any) : Boolean

    The equality method defined in AnyRef.

    The equality method defined in AnyRef[email protected] true if the receiver object is equivalent to the argument; false otherwise. */

    definition classes: FailureEquals → AnyRef → Any
  14. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
  15. def flatMapWithNext [U] (f: (Nothing) ⇒ (Input) ⇒ ParseResult[U]) : ParseResult[U]

    definition classes: NoSuccessParseResult
  16. def get : Nothing

    Returns the embedded result

    Returns the embedded result

    definition classes: NoSuccessParseResult
  17. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  18. def getOrElse [B >: T] (default: ⇒ B) : B

    definition classes: ParseResult
  19. def hashCode () : Int

    Returns a hash code value for the object.

    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.

    definition classes: Failure → AnyRef → Any
  20. def isEmpty : Boolean

    definition classes: ParseResult
  21. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  22. def map [U] (f: (Nothing) ⇒ U) : NoSuccess

    Functional composition of ParseResults

    Functional composition of ParseResults

    returns

    f' applied to the result of this ParseResult', packaged up as a new ParseResult'

    definition classes: NoSuccessParseResult
  23. def mapPartial [U] (f: PartialFunction[Nothing, U], error: (Nothing) ⇒ String) : ParseResult[U]

    Partial functional composition of ParseResults

    Partial functional composition of ParseResults

    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'.

    definition classes: NoSuccessParseResult
  24. val msg : String

    An error message string describing the failure.

    An error message string describing the failure.

    definition classes: FailureNoSuccess
  25. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  26. val next : Input

    The parser's unconsumed input at the point where the failure occurred.

    The parser's unconsumed input at the point where the failure occurred.

    definition classes: FailureNoSuccessParseResult
  27. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  28. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  29. def productArity : Int

    return k for a product A(x_1,...,x_k)

    return k for a product A(x_1,...,x_k)

    definition classes: FailureProduct
  30. def productElement (arg0: Int) : Any

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    returns

    The element n elements after the first element

    definition classes: FailureProduct
  31. def productElements : Iterator[Any]

    definition classes: Product
      deprecated:
    1. use productIterator instead

  32. def productIterator : Iterator[Any]

    An iterator that returns all fields of this product

    An iterator that returns all fields of this product

    definition classes: Product
  33. def productPrefix : String

    By default the empty 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.

    definition classes: FailureProduct
  34. val successful : Boolean

    definition classes: NoSuccessParseResult
  35. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  36. def toString () : String

    The toString method of a Failure yields an error [email protected] a string representation of the object.

    The toString method of a Failure yields an error [email protected] a string representation of the object. */

    definition classes: Failure → AnyRef → Any
  37. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  38. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  39. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from Product

Inherited from Equals

Inherited from NoSuccess

Inherited from ParseResult[Nothing]

Inherited from AnyRef

Inherited from Any