scala

Product

trait Product extends Equals

Base trait for all products, which in the standard library include at least scala.Product1 through scala.Product22 and therefore also their subclasses scala.Tuple1 through scala.Tuple22. In addition, all case classes implement Product with synthetically generated methods.

Source
Product.scala
Version

1.0

Since

2.3

Linear Supertypes
Known Subclasses
!, ::, ANY, Alternative, AlternativeApi, Annotated, AnnotatedApi, AnyHedgeRHS, AnyTreeRHS, AppliedTypeTree, AppliedTypeTreeApi, Apply, ApplyApi, Assign, AssignApi, AssignOrNamedArg, AssignOrNamedArgApi, AttListDecl, AttrDecl, BackgroundChanged, Bind, BindApi, BlackTree, Block, BlockApi, BooleanFlag, BoundElement, Box, Break, ButtonClicked, Call, CaretUpdate, CaseDef, CaseDefApi, ClassDef, ClassDefApi, Comment, ComponentAdded, ComponentRemoved, CompositeThrowable, CompoundTypeTree, CompoundTypeTreeApi, ConsRHS, DEFAULT, Deadline, Def, DefDef, DefDefApi, DefTree, DefTreeApi, DocBreak, DocCons, DocGroup, DocNest, DocNil, DocText, DocType, Done, ELEMENTS, EMPTY, EOF, EditDone, ElemDecl, ElemName, Empty, EmptyHedgeRHS, EmptyIcon, End, EntityRef, Eps, Error, ErrorToken, EvComment, EvElemEnd, EvElemStart, EvEntityRef, EvProcInstr, EvText, ExistentialTypeTree, ExistentialTypeTreeApi, Exit, ExtDef, Failure, Failure, FatalError, FocusGained, FocusLost, FontChanged, ForegroundChanged, Function, FunctionApi, GenericApply, GenericApplyApi, Group, IMPLIED, Ident, Ident, IdentApi, IdentContextApi, Identifier, If, IfApi, ImplDef, ImplDefApi, Import, ImportApi, Include, Index, IntDef, JSONArray, JSONObject, KeyPressed, KeyReleased, KeyTyped, Keyword, LabelDef, LabelDefApi, LabelledRHS, Left, LeftProjection, Letter, List, ListSelectionChanged, Literal, LiteralApi, LocalApply0, Locator, Lowered, MIXED, MalformedAttributeException, Match, MatchApi, MemberDef, MemberDefApi, ModuleDef, ModuleDefApi, MouseClicked, MouseDragged, MouseEntered, MouseExited, MouseMoved, MousePressed, MouseReleased, MouseWheelMoved, NameTree, NameTreeApi, NamedSend, NamespaceBinding, New, NewApi, Nil, NoAction, NoLo, NoMenuBar, Node, Node, None, NotationDecl, Null, Number, NumericLit, OffsetPosition, Option, PCDATA, PEReference, POISON, PackageDef, PackageDefApi, Para, ParameterEntityDecl, ParseException, ParsedEntityDecl, Point, ProcInstr, Product1, Product10, Product11, Product12, Product13, Product14, Product15, Product16, Product17, Product18, Product19, Product2, Product20, Product21, Product22, Product3, Product4, Product5, Product6, Product7, Product8, Product9, PublicID, REQUIRED, Raised, RedTree, Ref, RefTree, RefTreeApi, ReferenceToBoxed, ReferenceToBoxedApi, ReificationException, RemoteApply0, Remove, Reset, Return, ReturnApi, Right, RightProjection, ScalaReflectionException, ScanLeaf, ScanNode, Select, SelectApi, SelectFromTypeTree, SelectFromTypeTreeApi, SelectionChanged, SendTo, SingletonTypeTree, SingletonTypeTreeApi, Some, Star, Star, StarApi, Start, Str, StringContext, StringLit, Success, Success, Super, SuperApi, SymTree, SymTreeApi, SymTreeContextApi, SystemID, TIMEOUT, TableChanged, TableColumnsSelected, TableRowsAdded, TableRowsRemoved, TableRowsSelected, TableStructureChanged, TableUpdated, Template, TemplateApi, TermTree, TermTreeApi, Terminate, This, ThisApi, Throw, ThrowApi, TopIter, TopScope, Tree, TreeApi, TreeContextApi, Try, TryApi, Tuple1, Tuple10, Tuple11, Tuple12, Tuple13, Tuple14, Tuple15, Tuple16, Tuple17, Tuple18, Tuple19, Tuple2, Tuple20, Tuple21, Tuple22, Tuple3, Tuple4, Tuple5, Tuple6, Tuple7, Tuple8, Tuple9, TypTree, TypTreeApi, TypeApply, TypeApplyApi, TypeBoundsTree, TypeBoundsTreeApi, TypeDef, TypeDefApi, TypeTree, TypeTreeApi, TypeTreeContextApi, TypecheckException, Typed, TypedApi, UIElementHidden, UIElementMoved, UIElementResized, UIElementShown, UnApply, UnApplyApi, UncaughtException, UnexpectedReificationException, UninitializedFieldError, UnparsedEntityDecl, Update, ValDef, ValDefApi, ValOrDefDef, ValOrDefDefApi, ValidationException, WeakHashMap, Wildcard, WindowActivated, WindowClosed, WindowClosing, WindowDeactivated, WindowDeiconified, WindowIconified, WindowOpened, ~
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Product
  2. Equals
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: 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.

    that

    the value being probed for possible equality

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    Equals
  2. abstract def getClass(): Class[_]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

    a class object corresponding to the runtime type of the receiver.

    Definition Classes
    Any
  3. abstract def productArity: Int

    The size of this product.

    The size of this product.

    returns

    for a product A(x1, ..., xk), returns k

  4. abstract def productElement(n: Int): Any

    The nth element of this product, 0-based.

    The nth element of this product, 0-based. In other words, for a product A(x1, ..., xk), returns x(n+1) where 0 < n < k.

    n

    the index of the element to return

    returns

    the element n elements after the first element

    Exceptions thrown
    `IndexOutOfBoundsException`

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  2. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Product to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  4. def ->[B](y: B): (Product, B)

    Implicit information
    This member is added by an implicit conversion from Product to ArrowAssoc[Product] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    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 expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(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 type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  7. def ensuring(cond: (Product) ⇒ Boolean, msg: ⇒ Any): Product

    Implicit information
    This member is added by an implicit conversion from Product to Ensuring[Product] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Product) ⇒ Boolean): Product

    Implicit information
    This member is added by an implicit conversion from Product to Ensuring[Product] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: ⇒ Any): Product

    Implicit information
    This member is added by an implicit conversion from Product to Ensuring[Product] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Product

    Implicit information
    This member is added by an implicit conversion from Product to Ensuring[Product] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def equals(arg0: 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 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 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)).

    returns

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

    Definition Classes
    Any
  12. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Product to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  13. 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.

    returns

    the hash code value for this object.

    Definition Classes
    Any
  14. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.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 specified type.

    returns

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

    Definition Classes
    Any
  15. def productIterator: Iterator[Any]

    An iterator over all the elements of this product.

    An iterator over all the elements of this product.

    returns

    in the default implementation, an Iterator[Any]

  16. def productPrefix: String

    A string used in the toString methods of derived classes.

    A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

    returns

    in the default implementation, the empty string

  17. def toString(): String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    Definition Classes
    Any
  18. def [B](y: B): (Product, B)

    Implicit information
    This member is added by an implicit conversion from Product to ArrowAssoc[Product] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Product to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (product: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Product to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (product: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Product

    Implicit information
    This member is added by an implicit conversion from Product to ArrowAssoc[Product] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (product: ArrowAssoc[Product]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Product

    Implicit information
    This member is added by an implicit conversion from Product to Ensuring[Product] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (product: Ensuring[Product]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Equals

Inherited from Any

Inherited by implicit conversion any2stringadd from Product to StringAdd

Inherited by implicit conversion any2stringfmt from Product to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Product to ArrowAssoc[Product]

Inherited by implicit conversion any2Ensuring from Product to Ensuring[Product]

Ungrouped