org.specs2.specification

SpecStart

case class SpecStart(specName: SpecName, arguments: Arguments, linked: Linked) extends Fragment with Product with Serializable

Start of a specification.

This fragment keeps 2 important pieces of information:

Linear Supertypes
Serializable, Serializable, Product, Equals, Fragment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. SpecStart
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Fragment
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpecStart(specName: SpecName, arguments: Arguments = main.Arguments.apply(), linked: Linked = ...)

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val arguments: Arguments

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def baseDirIs(dir: String): SpecStart

    set the base directory for the generated documentation

  9. def canEqual(arg0: Any): Boolean

    Definition Classes
    SpecStart → Equals

  10. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    SpecStart → Equals → AnyRef → Any

  13. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  14. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Definition Classes
    SpecStart → AnyRef → Any

  16. def hidden: Boolean

    returns

    true if this spec must not be displayed

  17. def isIncludeLink: Boolean

    returns

    true if this spec starts only contains a link including another specification

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. def isLink: Boolean

    returns

    true if this spec starts only contains a link to another specification

  20. def isSeeOnlyLink: Boolean

    returns

    true if this spec starts only contains a link referencing another specification

  21. def link: Option[HtmlLink]

    returns

    the html link if any

  22. def linkToString: String

  23. val linked: Linked

  24. val location: Location

    Definition Classes
    Fragment

  25. def matches(s: String): Boolean

    Definition Classes
    SpecStart → Fragment

  26. def name: String

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  30. def overrideArgs(args: Arguments): SpecStart

    the new arguments take override the old ones where defined

  31. def productArity: Int

    Definition Classes
    SpecStart → Product

  32. def productElement(arg0: Int): Any

    Definition Classes
    SpecStart → Product

  33. def productIterator: Iterator[Any]

    Definition Classes
    Product

  34. def productPrefix: String

    Definition Classes
    SpecStart → Product

  35. val specName: SpecName

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  37. def title: String

  38. def toString(): String

    Definition Classes
    SpecStart → AnyRef → Any

  39. def unlink: SpecStart

    returns

    a non-linked start

  40. def urlIs(url: String): SpecStart

    set the url for the generated documentation

  41. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  42. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  43. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  44. def withArgs(args: Arguments): SpecStart

    the new arguments take precedence over the old ones

  45. def withName(n: SpecName): SpecStart

    The name of the specification can be overriden with a user defined title

Deprecated Value Members

  1. def productElements: Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Fragment

Inherited from AnyRef

Inherited from Any