Packages

c

grizzled.string.template

UnixShellStringTemplate

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.

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)

    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)

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def findVariableReference(s: String): Option[Variable]

    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
    UnixShellStringTemplate → StringTemplate
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. val resolveVar: (String) ⇒ Option[String]
    Definition Classes
    StringTemplate
  17. val safe: Boolean
    Definition Classes
    StringTemplate
  18. def sub(s: String): Try[String]

    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

    Success(substitutedValue) or Failure(error)

    Definition Classes
    UnixShellStringTemplate → StringTemplate
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from StringTemplate

Inherited from AnyRef

Inherited from Any

Ungrouped