Class

grizzled.string.template

UnixShellStringTemplate

Related Doc: package template

Permalink

class UnixShellStringTemplate extends StringTemplate

A string template that uses the Unix shell-like syntax ${varname} (or $varname) for variable references. A variable's name may consist of alphanumerics and underscores. To include a literal "$" in a string, escape it with a backslash.

For this class, the general form of a variable reference is:

${varname?default}

}

The ?default suffix is optional and specifies a default value to be used if the variable has no value.

A shorthand form of a variable reference is:

$varname

The default capability is not available in the shorthand form.

Annotations
@SuppressWarnings()
Linear Supertypes
StringTemplate, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UnixShellStringTemplate
  2. StringTemplate
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UnixShellStringTemplate(resolveVar: (String) ⇒ Option[String], safe: Boolean)

    Permalink

    Alternate constructor that uses a variable name pattern that permits variable names with alphanumerics and underscore.

    Alternate constructor that uses a variable name pattern that permits variable names with alphanumerics and underscore.

    resolveVar

    A function that takes a variable name as a parameter and returns an Option[String] value for the variable, or None if there is no value (Map[String, String].get(), for instance).

    safe

    true for a "safe" template that just substitutes a blank string for an unknown variable, false for one that throws an exception.

  2. new UnixShellStringTemplate(resolveVar: (String) ⇒ Option[String], namePattern: String, safe: Boolean)

    Permalink

    resolveVar

    A function that takes a variable name as a parameter and returns an Option[String] value for the variable, or None if there is no value (Map[String, String].get(), for instance).

    namePattern

    Regular expression pattern to match a variable name, as a string (not a Regex). For example: "[a-zA-Z0-9_]+"

    safe

    true for a "safe" template that just substitutes a blank string for an unknown variable, false for one that throws an exception.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def findVariableReference(s: String): Option[Variable]

    Permalink

    Parse the location of the first variable in string.

    Parse the location of the first variable in string.

    s

    the string

    returns

    an Option[Variable], specifying the variable's location; or None if not found

    Attributes
    protected
    Definition Classes
    UnixShellStringTemplateStringTemplate
  10. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. val resolveVar: (String) ⇒ Option[String]

    Permalink

    A function that takes a variable name as a parameter and returns an Option[String] value for the variable, or None if there is no value (Map[String, String].get(), for instance).

    A function that takes a variable name as a parameter and returns an Option[String] value for the variable, or None if there is no value (Map[String, String].get(), for instance).

    Definition Classes
    StringTemplate
  17. val safe: Boolean

    Permalink

    true for a "safe" template that just substitutes a blank string for an unknown variable, false for one that throws an exception.

    true for a "safe" template that just substitutes a blank string for an unknown variable, false for one that throws an exception.

    Definition Classes
    StringTemplate
  18. def sub(s: String): Either[String, String]

    Permalink

    Replace all variable references in the given string.

    Replace all variable references in the given string. Variable references are recognized per the regular expression passed to the constructor. If a referenced variable is not found in the resolver, this method either:

    - throws a VariableNotFoundException (if safe is false), or - substitutes an empty string (if safe is true)

    Recursive references are supported (but beware of infinite recursion).

    s

    the string in which to replace variable references

    returns

    On success, Right(result). On failure, Left(error)

    Definition Classes
    UnixShellStringTemplateStringTemplate
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StringTemplate

Inherited from AnyRef

Inherited from Any

Ungrouped