Class QuotedString.BourneStyle

java.lang.Object
org.eclipse.jgit.util.QuotedString
org.eclipse.jgit.util.QuotedString.BourneStyle
Direct Known Subclasses:
QuotedString.BourneUserPathStyle
Enclosing class:
QuotedString

public static class QuotedString.BourneStyle extends QuotedString
Quoting style used by the Bourne shell.

Quotes are unconditionally inserted during quote(String). This protects shell meta-characters like $ or ~ from being recognized as special.

  • Constructor Details

    • BourneStyle

      public BourneStyle()
  • Method Details

    • quote

      public String quote(String in)
      Description copied from class: QuotedString
      Quote an input string by the quoting rules.

      If the input string does not require any quoting, the same String reference is returned to the caller.

      Otherwise a quoted string is returned, including the opening and closing quotation marks at the start and end of the string. If the style does not permit raw Unicode characters then the string will first be encoded in UTF-8, with unprintable sequences possibly escaped by the rules.

      Specified by:
      quote in class QuotedString
      Parameters:
      in - any non-null Unicode string.
      Returns:
      a quoted string. See above for details.
    • dequote

      public String dequote(byte[] in, int ip, int ie)
      Description copied from class: QuotedString
      Decode a previously quoted input, scanning a UTF-8 encoded buffer.

      This method must match quote such that:

       a.equals(dequote(Constants.encode(quote(a))));
       
      is true for any a.

      This method removes any opening/closing quotation marks added by QuotedString.quote(String).

      Specified by:
      dequote in class QuotedString
      Parameters:
      in - the input buffer to parse.
      ip - first position within in to scan.
      ie - one position past in in to scan.
      Returns:
      the cleaned string.