org.clapper.scalasti

StringTemplateGroup

class StringTemplateGroup extends AnyRef

A Scala wrapper for the String Template library's StringTemplateGroup class.

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

Instance Constructors

  1. new StringTemplateGroup(source: Source, errorListener: StringTemplateErrorListener)

    Alternate constructor that creates a template group from the group defined by a readable source.

    Alternate constructor that creates a template group from the group defined by a readable source. Useful for reading template group files.

    source

    the source from which to read

    errorListener

    an error listener to receive errors

  2. new StringTemplateGroup(source: Source)

    Alternate constructor that creates a template group from the group defined by a readable source.

    Alternate constructor that creates a template group from the group defined by a readable source. Useful for reading template group files.

    source

    the source from which to read

  3. new StringTemplateGroup(groupName: String)

    Alternate constructor that creates a template group manager for templates that are to be loaded as resources via the class loader.

    Alternate constructor that creates a template group manager for templates that are to be loaded as resources via the class loader.

    groupName

    the group's name

  4. new StringTemplateGroup(groupName: String, directory: File)

    Alternate constructor that creates a template group manager for templates that are at, or below, the specified directory.

    Alternate constructor that creates a template group manager for templates that are at, or below, the specified directory.

    groupName

    the group's name

    directory

    the directory containing the templates

  5. new StringTemplateGroup(group: antlr.stringtemplate.StringTemplateGroup)

    group

    the actual, underlying String Template library group object.

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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. def defineTemplate(name: String, contents: String): StringTemplate

    Create a new template and associate it with the specified name within the group.

    Create a new template and associate it with the specified name within the group. If the group already contains a template with the same name, this new template replaces the existing template.

    name

    the template name

    contents

    the template's contents (i.e., the template string)

    returns

    the template object

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

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

    Definition Classes
    AnyRef → Any
  11. def errorListener: antlr.stringtemplate.StringTemplateErrorListener

    Get the current error listener, which is notified when errors occur.

    Get the current error listener, which is notified when errors occur.

    returns

    the error listener

  12. def errorListener_=(listener: StringTemplateErrorListener): Unit

    Set the current error listener, which is notified when errors occur.

    Set the current error listener, which is notified when errors occur.

    listener

    the error listener

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  16. def isDefined(name: String): Boolean

    Determine whether this group contains a template with a given name.

    Determine whether this group contains a template with a given name.

    name

    the template name to check

    returns

    true if a template exists by that name, false if not

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. def nativeTemplateGroup: antlr.stringtemplate.StringTemplateGroup

    Returns a copy of the underlying (wrapped) StringTemplate API object.

    Returns a copy of the underlying (wrapped) StringTemplate API object.

    returns

    a copy of the underlying StringTemplateGroup object.

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

    Definition Classes
    AnyRef
  20. def newEmptyTemplate: antlr.stringtemplate.StringTemplate

    Create an empty template within this group.

    Create an empty template within this group. This method corresponds to the underlying API's createStringTemplate() method.

    returns

    the empty template

  21. final def notify(): Unit

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

    Definition Classes
    AnyRef
  23. def refreshInterval: Int

    Get the refresh interval, which defines how often templates are refreshed from disk.

    Get the refresh interval, which defines how often templates are refreshed from disk. An interval of 0 means there's no caching, and templates are loaded every time they are retrieved; any other value represents how long, in milliseconds, to cache templates in memory before checking disk again to see if they've changed.

    returns

    the refresh interval

  24. def refreshInterval_=(interval: Int): Unit

    Set the refresh interval, which defines how often templates are refreshed from disk.

    Set the refresh interval, which defines how often templates are refreshed from disk. An interval of 0 means there's no caching, and templates are loaded every time they are retrieved; any other value represents how long, in milliseconds, to cache templates in memory before checking disk again to see if they've changed.

    interval

    the new refresh interval

  25. def registerRenderer[T](attrRenderer: AttributeRenderer[T])(implicit arg0: ClassTag[T]): Unit

    Register an attribute renderer for a specific type.

    Register an attribute renderer for a specific type. The attribute renderer object must implement the AttributeRenderer trait for the specific type.

    attrRenderer

    the attribute renderer to use for values of type T

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

    Definition Classes
    AnyRef
  27. def template(templateName: String): StringTemplate

    Equivalent to the String Template library's getInstanceOf() method, this method returns the template with the specified name, returning the template if found, or None if not.

    Equivalent to the String Template library's getInstanceOf() method, this method returns the template with the specified name, returning the template if found, or None if not.

    templateName

    the template name

    returns

    the template. Throws an exception if the template isn't found.

  28. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any

Ungrouped