org.clapper.scalasti.STGroupString.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalasti_2.10 Show documentation

A Scala-friendly wrapper for Terence Parr's ST library

The newest version!

package org.clapper.scalasti

import org.stringtemplate.v4.{STGroupString => _STGroupString}

/** `STGroupString` wraps the StringTemplate API's `STGroupString` class.
  * An `STGroupString` object reads a template group from a string. See the
  * StringTemplate API documentation for details. Since `STGroupString` a
  * subclass of `STGroup`, all the methods on the parent class are available
  * on this one. This class cannot be instantiated directly; use the `apply()`
  * methods on the companion object.
  */
class STGroupString private[scalasti](native: _STGroupString)
  extends STGroup(native = native) {

  /** Create a new underlying StringTemplate object, applying whatever
    * constructor parameters were used with the current object. Does not
    * apply the attrRenderers.
    *
    * Subclasses should override this method.
    *
    * @return the new underlying object
    */
  override protected[this] def newUnderlying: _STGroupString = {
    new _STGroupString(native.sourceName,
                       native.text,
                       native.delimiterStartChar,
                       native.delimiterStopChar)
  }
}

/** Companion object for `STGroupString`. This object provides `apply()`
  * methods for instantiating `STGroupString` objects.
  */
object STGroupString {

  /** Create an `STGroupString`.
    *
    * @param text                the text of the template group
    * @param sourceName          the name to assign the group, if any
    * @param startDelimiter  the starting delimiter character
    * @param endDelimiter   the ending delimiter character
    *
    * @return the group
    */
  def apply(text:               String,
            sourceName:         String = "",
            startDelimiter: Char = Constants.DefaultStartChar,
            endDelimiter:  Char = Constants.DefaultStopChar):
    STGroupString = {

    val native = new _STGroupString(sourceName,
                                    text,
                                    startDelimiter,
                                    endDelimiter)
    new STGroupString(native)
  }
}