net.shibboleth.idp.installer

Class PropertiesWithComments

java.lang.Object

net.shibboleth.idp.installer.PropertiesWithComments

public class PropertiesWithComments
extends Object

A package which is similar to Properties, but allows comments to be preserved. We use the Properties package to parse the non-comment lines.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PropertiesWithComments.CommentedProperty A POJO which looks like a property.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Object>	contents The contents.
private Map<String,PropertiesWithComments.CommentedProperty>	properties The properties bit.

Constructor Summary

Constructors

Constructor and Description
PropertiesWithComments()

Method Summary

Methods

Modifier and Type	Method and Description
void	addComment(String what) Append a comment to the list.
protected void	addCommentedProperty(String line, boolean isComment) Add a property, either as a key/value pair or as a key/comment pair.
void	load(InputStream input) Read the input stream into our structures.
boolean	replaceProperty(String propName, String newPropValue) Replace the supplied property or stuff it at the bottom of the list.
void	store(OutputStream output) Put the output to the supplied stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

contents

private List<Object> contents

The contents. Each Object is either a string (a non-property line) or a PropertiesWithComments.CommentedProperty (an optionally commented property definition).

properties

private Map<String,PropertiesWithComments.CommentedProperty> properties

The properties bit.

Constructor Detail

PropertiesWithComments

public PropertiesWithComments()

Method Detail

addCommentedProperty

protected void addCommentedProperty(@Nonnull@NotEmpty
                        String line,
                        boolean isComment)
                             throws IOException

Add a property, either as a key/value pair or as a key/comment pair.

Parameters:

line - what to look at

isComment - whether this is a comment or not.

Throws:

IOException - when badness happens.

load

public void load(InputStream input)
          throws IOException

Read the input stream into our structures.

Parameters:

input - what to read

Throws:

IOException - if readline fails

store

public void store(OutputStream output)
           throws IOException

Put the output to the supplied stream.

Parameters:

output - where to write

Throws:

IOException - is the write fails

replaceProperty

public boolean replaceProperty(String propName,
                      String newPropValue)

Replace the supplied property or stuff it at the bottom of the list.

Parameters:

propName - the name of the property to replace

newPropValue - the value to replace

Returns:

true if the property was replaced false if it was added

addComment

public void addComment(String what)

Append a comment to the list.

Parameters:

what - what to add