laika.tree

IdGenerators

object IdGenerators

Generators for various different types of automatically generated identifiers.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IdGenerators
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Anonymous(pos: Int) extends Id with Product with Serializable

    Represents a positional anonymous id.

  2. case class Generated(generator: (Set[String]) ⇒ String) extends Id with Product with Serializable

    Represents a generated id based on the provided generator function.

  3. case class Hybrid(id: String, display: Id) extends Id with Product with Serializable

    Represents a hybrid id, with one identifier used as a selector for finding matching reference elements and the other merely used for rendering.

  4. sealed abstract class Id extends AnyRef

    Represents an identifier for an element in the document tree.

  5. class IdMap extends AnyRef

    Maps original ids to their final generated ids.

  6. case class Named(name: String) extends Id with Product with Serializable

    Represents an id with a unique string identifier.

  7. class NumberGenerator extends (Set[String]) ⇒ String

    Generates ascending sequences of numeric identifiers, starting with 1.

  8. case class Relative(path: Path, name: String) extends Id with Product with Serializable

    Represents an id that captures a relationship between two paths.

  9. class SymbolGenerator extends (Set[String]) ⇒ String

    Generates symbol identifiers.

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. object Hidden extends Id with Product with Serializable

    Represents an id that is not getting used in the final rendering step.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. implicit def stringToId(name: String): Named

    Converts the specified string to an Id instance that represents a unique identifier.

  19. def suggestedId(suggested: String, map: IdMap): Generated

    Generates an identifier based on a concrete suggestion.

    Generates an identifier based on a concrete suggestion. If the suggested id is not already contained in the Set of used identifiers passed to the function it will be used as is. Otherwise it will try to append numbers (-1, -2, and so on) until it finds an unused id.

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

    Definition Classes
    AnyRef

  21. def toString(): String

    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped