Field Detail

• out_

  private final java.io.OutputStream out_

• linesep_

  private static final byte[] linesep_

• TOKEN_REGEX

  private static final java.lang.String TOKEN_REGEX

  See Also:

  Constant Field Values

• TOKEN_PATTERN

  private static final java.util.regex.Pattern TOKEN_PATTERN

Constructor Detail

• LockWriter

  public LockWriter(java.io.OutputStream out)

  Constructs a writer for writing to a given output stream.

  Parameters:

  out - output stream

Method Detail

• writeAssignments

  public void writeAssignments(java.util.Map map)
                        throws java.io.IOException

  Writes all the assignments in a given map to the lockfile.

  Parameters:

  map - assignment set to output

  Throws:

  java.io.IOException

• writeAssignment

  public void writeAssignment(java.lang.String name,
                              java.lang.String value)
                       throws java.io.IOException

  Writes a single assignment to the lockfile.

  Parameters:

  name - assignment key

  value - assignment value

  Throws:

  java.io.IOException

• writeComment

  public void writeComment(java.lang.String comment)
                    throws java.io.IOException

  Writes a comment line to the lockfile.

  Parameters:

  comment - comment text

  Throws:

  java.io.IOException

• writeLine

  public void writeLine()
                 throws java.io.IOException

  Writes a blank line to the lockfile.

  Throws:

  java.io.IOException

• writeLine

  protected void writeLine(java.lang.String line)
                    throws java.io.IOException

  Writes a line of text to the lockfile, terminated with a line-end.

  Parameters:

  line - line to write

  Throws:

  java.io.IOException

• close

  public void close()
             throws java.io.IOException

  Closes the output stream. May be required to ensure that all data is written.

  Throws:

  java.io.IOException

• setLockPermissions

  public static void setLockPermissions(java.io.File file)
                                 throws java.io.IOException

  Sets the permissions on a given file suitably for a SAMP Standard Profile lockfile. This means that nobody apart from the file's owner can read it.

  Parameters:

  file - file to set access permissions on

  Throws:

  java.io.IOException

• getLineSeparator

  private static final byte[] getLineSeparator()

  Returns the platform-specific line separator sequence as an array of bytes.

  Returns:

  line separator sequence