Package com.iizix.license.history

Class LicensingHistory

java.lang.Object

com.iizix.license.history.LicensingHistory

All Implemented Interfaces:

java.io.Serializable

public final class LicensingHistory
extends java.lang.Object
implements java.io.Serializable

Class used to hold information about licensing history, i.e. what has been done and when in regards to the license.

Author:

Christopher Mindus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.ArrayList<LicensingHistoryEntry>	history	List of entries.

Constructor Summary

Constructors

Constructor	Description
LicensingHistory()	Public constructor to create an empty history.

Method Summary

Modifier and Type	Method	Description
void	addEntries(LicensingHistoryEntry[] entries, int startIndex)	Removes all history entries before the specified index.
void	addEntry(LicensingHistoryEntry entry)	Adds a new history entry.
void	addEntry(LicensingHistoryEvent event, java.lang.String text)	Adds a new history entry.
LicensingHistoryEntry[]	getEntries()	Gets all the entries.
void	list(java.lang.StringBuilder sb, java.lang.String indent)	Lists the history with an indent string to a StringBuilder.
int	removeAllEntriesAtAndAfter(int index)	Removes all history entries before the specified index.
java.lang.String	toString()	Produces a String representation.

Methods inherited from class java.lang.Object

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

Field Detail

history

protected final java.util.ArrayList<LicensingHistoryEntry> history

List of entries.

Constructor Detail

LicensingHistory

public LicensingHistory()

Public constructor to create an empty history.

Method Detail

addEntry

public void addEntry(LicensingHistoryEvent event,
                     java.lang.String text)

Adds a new history entry.

Parameters:

event - The event.

text - The text.

Throws:

java.lang.NullPointerException - If event or text is null.

addEntry

public void addEntry(LicensingHistoryEntry entry)

Adds a new history entry.

Parameters:

entry - The entry to add.

Throws:

java.lang.NullPointerException - If event or text is null.

removeAllEntriesAtAndAfter

public int removeAllEntriesAtAndAfter(int index)

Removes all history entries before the specified index. In other words, this call will keep all history entries with index values less than the index parameter.

Parameters:

index - The index.

Returns:

Number of entries removed.

addEntries

public void addEntries(LicensingHistoryEntry[] entries,
                       int startIndex)

Removes all history entries before the specified index. In other words, this call will keep all history entries with index values less than the index parameter.

Parameters:

entries - The entries to add.

startIndex - The starting index.

getEntries

public LicensingHistoryEntry[] getEntries()

Gets all the entries.

list

public void list(java.lang.StringBuilder sb,
                 java.lang.String indent)

Lists the history with an indent string to a StringBuilder.

Parameters:

sb - The StringBuilder.

indent - The indent string.

toString

public java.lang.String toString()

Produces a String representation.

Overrides:

toString in class java.lang.Object

Returns:

A String of history entries.