org.specs2.specification

BaseSpecification

trait BaseSpecification extends SpecificationStructure with FragmentsBuilder with SpecificationInclusion

A Base specification contains the minimum elements for a Specification

- a Seq of Fragments, available through the SpecificationStructure trait - methods for creating Fragments from the FragmentsBuilder trait - methods to include other specifications

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BaseSpecification
  2. SpecificationInclusion
  3. FragmentsBuilder
  4. FormattingTags
  5. Tags
  6. ImplicitParameters
  7. ExamplesFactory
  8. SpecificationStructure
  9. DefaultFragmentsFormatting
  10. TagsAssociation
  11. FragmentsFormatting
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class AsFragments(fs: Fragments) extends Product with Serializable

    Definition Classes
    FragmentsBuilder
  2. class ExampleDesc extends AnyRef

    transient class to hold an example description before creating a full Example

  3. case class FormattingTagParameter(condition: Boolean) extends Product with Serializable

    Definition Classes
    FormattingTags
  4. class HtmlLinkFragments extends AnyRef

    Definition Classes
    FragmentsBuilder
  5. class HtmlLinkFragments2 extends AnyRef

    Definition Classes
    FragmentsBuilder
  6. trait ImplicitParam extends AnyRef

    Definition Classes
    ImplicitParameters
  7. trait ImplicitParam1 extends AnyRef

    Definition Classes
    ImplicitParameters
  8. trait ImplicitParam10 extends AnyRef

    Definition Classes
    ImplicitParameters
  9. trait ImplicitParam2 extends AnyRef

    Definition Classes
    ImplicitParameters
  10. trait ImplicitParam3 extends AnyRef

    Definition Classes
    ImplicitParameters
  11. trait ImplicitParam4 extends AnyRef

    Definition Classes
    ImplicitParameters
  12. trait ImplicitParam5 extends AnyRef

    Definition Classes
    ImplicitParameters
  13. trait ImplicitParam6 extends AnyRef

    Definition Classes
    ImplicitParameters
  14. trait ImplicitParam7 extends AnyRef

    Definition Classes
    ImplicitParameters
  15. trait ImplicitParam8 extends AnyRef

    Definition Classes
    ImplicitParameters
  16. trait ImplicitParam9 extends AnyRef

    Definition Classes
    ImplicitParameters
  17. case class SpecIdentificationMarkdownLink(s: String) extends Product with Serializable

    Definition Classes
    FragmentsBuilder
  18. class SpecTitle extends AnyRef

    Definition Classes
    FragmentsBuilder

Abstract Value Members

  1. abstract def is: Fragments

    declaration of Fragments from the user

    declaration of Fragments from the user

    Definition Classes
    SpecificationStructure

Concrete 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. implicit def ToFormattingTagParameter(condition: Boolean): Option[FormattingTagParameter]

    Definition Classes
    FormattingTags
  7. implicit def argumentsFragment(a: Arguments): FragmentsFragment

    Arguments creation

    Arguments creation

    returns

    a Fragments object which can be chained with other fragments

    Definition Classes
    FragmentsBuilder
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. implicit def exampleFactory: ExampleFactory

    Definition Classes
    ExamplesFactory
  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. implicit def forExample(s: String): ExampleDesc

    Example creation

    Example creation

    returns

    an Example description from a string, to create a full Example once the body is defined

    Definition Classes
    FragmentsBuilder
  15. def formatFragments: (Fragments) ⇒ Fragments

    format a list of fragments according to their formatting tags

    format a list of fragments according to their formatting tags

    Definition Classes
    DefaultFragmentsFormattingFragmentsFormatting
  16. def formatSection(markdown: Option[FormattingTagParameter] = None, flow: Option[FormattingTagParameter] = None, verbatim: Option[FormattingTagParameter] = None): TaggingFragment

    add a tagging section with special tag names specifying the formatting options

    add a tagging section with special tag names specifying the formatting options

    Definition Classes
    FormattingTags
  17. def formatTag(markdown: Option[FormattingTagParameter] = None, flow: Option[FormattingTagParameter] = None, verbatim: Option[FormattingTagParameter] = None): TaggingFragment

    add a tag with special tag names specifying the formatting options

    add a tag with special tag names specifying the formatting options

    Definition Classes
    FormattingTags
  18. implicit def fragmentFragments(f: ⇒ Fragment): FragmentsFragment

    Definition Classes
    FragmentsBuilder
  19. implicit def fragments(f: ⇒ Fragment): Fragments

    returns

    a Fragments object from a single Fragment

    Definition Classes
    FragmentsBuilder
  20. implicit def fragmentsFragmentToFragments(fs: FragmentsFragment): Fragments

    reverse conversion from a Fragment containing a Fragments object to the Fragments object

    reverse conversion from a Fragment containing a Fragments object to the Fragments object

    Definition Classes
    FragmentsBuilder
  21. implicit def fragmentsFragments(fs: ⇒ Fragments): FragmentsFragment

    Definition Classes
    FragmentsBuilder
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. def identification: SpecIdentification

    specName provides useful information identifying the specification: title, className, url.

    specName provides useful information identifying the specification: title, className, url...

    Definition Classes
    SpecificationStructure
  25. implicit def identifySpecificationStructure(s: SpecificationStructure): SpecIdentification

    automatically convert a specification to its identification

    automatically convert a specification to its identification

    Definition Classes
    SpecificationStructure
  26. implicit lazy val implicitParam: ImplicitParam

    Definition Classes
    ImplicitParameters
  27. implicit lazy val implicitParam1: ImplicitParam1

    Definition Classes
    ImplicitParameters
  28. implicit lazy val implicitParam10: ImplicitParam10

    Definition Classes
    ImplicitParameters
  29. implicit lazy val implicitParam2: ImplicitParam2

    Definition Classes
    ImplicitParameters
  30. implicit lazy val implicitParam3: ImplicitParam3

    Definition Classes
    ImplicitParameters
  31. implicit lazy val implicitParam4: ImplicitParam4

    Definition Classes
    ImplicitParameters
  32. implicit lazy val implicitParam5: ImplicitParam5

    Definition Classes
    ImplicitParameters
  33. implicit lazy val implicitParam6: ImplicitParam6

    Definition Classes
    ImplicitParameters
  34. implicit lazy val implicitParam7: ImplicitParam7

    Definition Classes
    ImplicitParameters
  35. implicit lazy val implicitParam8: ImplicitParam8

    Definition Classes
    ImplicitParameters
  36. implicit lazy val implicitParam9: ImplicitParam9

    Definition Classes
    ImplicitParameters
  37. def include(args: Arguments, f: Fragments, fs: Fragments*): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  38. def include(args: Arguments, f: Fragments): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  39. def include(args: Arguments, s: SpecificationStructure, ss: SpecificationStructure*): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  40. def include(args: Arguments, s: SpecificationStructure): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  41. def include(s: SpecificationStructure, ss: SpecificationStructure*): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  42. implicit def include(s: SpecificationStructure): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  43. def include(f: Fragments, fs: Fragments*): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  44. def include(f: Fragments): FragmentsFragment

    Definition Classes
    SpecificationInclusion
  45. def inline(specs: SpecificationStructure*): Fragments

    add the fragments of another specification without start and end

    add the fragments of another specification without start and end

    Definition Classes
    SpecificationInclusion
  46. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  47. def link(htmlLink: HtmlLink, f: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  48. def link(htmlLink: HtmlLink, s: SpecificationStructure): Fragments

    create a link directly on a specification, with a given link

    create a link directly on a specification, with a given link

    Definition Classes
    FragmentsBuilder
  49. def link(fss: Seq[Fragments]): Fragments

    Definition Classes
    FragmentsBuilder
  50. def link(fs: Fragments, fss: Fragments*): Fragments

    Definition Classes
    FragmentsBuilder
  51. def link(fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  52. def link(ss: Seq[SpecificationStructure], dummy: Int = 0): Fragments

    Definition Classes
    FragmentsBuilder
  53. def link(s: SpecificationStructure, ss: SpecificationStructure*): Fragments

    Definition Classes
    FragmentsBuilder
  54. def link(s: SpecificationStructure): Fragments

    create a link directly on a specification

    create a link directly on a specification

    Definition Classes
    FragmentsBuilder
  55. def map(fs: ⇒ Fragments): Fragments

    this method can be overridden to map additional behavior in the user-defined fragments

    this method can be overridden to map additional behavior in the user-defined fragments

    Definition Classes
    SpecificationStructure
  56. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  57. final def notify(): Unit

    Definition Classes
    AnyRef
  58. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  59. def section(names: String*): TaggingFragment

    create a AsSection fragment

    create a AsSection fragment

    Definition Classes
    Tags
  60. def see(htmlLink: HtmlLink, fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  61. def see(htmlLink: HtmlLink, s: SpecificationStructure): Fragments

    create a see-only link directly on a specification, with a given link

    create a see-only link directly on a specification, with a given link

    Definition Classes
    FragmentsBuilder
  62. def see(fss: Seq[Fragments]): Fragments

    Definition Classes
    FragmentsBuilder
  63. def see(fs: Fragments, fss: Fragments*): Fragments

    Definition Classes
    FragmentsBuilder
  64. def see(fs: Fragments): Fragments

    Definition Classes
    FragmentsBuilder
  65. def see(s: SpecificationStructure): Fragments

    Definition Classes
    FragmentsBuilder
  66. def see(ss: Seq[SpecificationStructure])(implicit p1: ImplicitParam1): Fragments

    Definition Classes
    FragmentsBuilder
  67. def see(s: SpecificationStructure, ss: SpecificationStructure*): Fragments

    create a html link without including the other specification fragments

    create a html link without including the other specification fragments

    Definition Classes
    FragmentsBuilder
  68. implicit def specIdentificationMarkdownLink(s: String): SpecIdentificationMarkdownLink

    create markdown links from string + spec identification

    create markdown links from string + spec identification

    Definition Classes
    FragmentsBuilder
  69. implicit def specificationStructureToFragments(s: SpecificationStructure): AsFragments

    this implicit allows to call some functions directly on a specification, like 'hide'

    this implicit allows to call some functions directly on a specification, like 'hide'

    Definition Classes
    FragmentsBuilder
  70. implicit def stringToHtmlLinkFragments(s: String): HtmlLinkFragments

    Links to other specifications creation

    Links to other specifications creation

    Definition Classes
    FragmentsBuilder
    See also

    org.specs2.UserGuide

  71. implicit def stringToHtmlLinkFragments2(s: String): HtmlLinkFragments2

    Definition Classes
    FragmentsBuilder
  72. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  73. def tag(names: String*): TaggingFragment

    create a TaggedAs fragment

    create a TaggedAs fragment

    Definition Classes
    Tags
  74. implicit def textFragment(s: String): FragmentsFragment

    returns

    create a Text Fragment from a string and allow it to be chained to other fragments

    Definition Classes
    FragmentsBuilder
  75. implicit def textStart(s: String): Fragments

    returns

    a Fragments object from a string

    Definition Classes
    FragmentsBuilder
  76. implicit def title(s: String): SpecTitle

    This method allows to add a title to the Specification.

    This method allows to add a title to the Specification. It can be used as an operation on a String: "spec title".title

    returns

    a Fragments object from a string, with the given title

    Definition Classes
    FragmentsBuilder
  77. def toString(): String

    Definition Classes
    AnyRef → Any
  78. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SpecificationInclusion

Inherited from FragmentsBuilder

Inherited from FormattingTags

Inherited from Tags

Inherited from ImplicitParameters

Inherited from ExamplesFactory

Inherited from SpecificationStructure

Inherited from TagsAssociation

Inherited from FragmentsFormatting

Inherited from AnyRef

Inherited from Any

Ungrouped