com.phloc.commons.changelog

Class ChangeLog

java.lang.Object

com.phloc.commons.changelog.ChangeLog

All Implemented Interfaces:

Serializable

@NotThreadSafe
public final class ChangeLog
extends Object
implements Serializable

This class represents a single change log with a list of entries and releases.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChangeLog(String sVersion, String sComponent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEntry(ChangeLogEntry aEntry) Add a new change log entry at the end.
void	addEntry(int nIndex, ChangeLogEntry aEntry) Add a new change log entry at the specified index.
void	addRelease(ChangeLogRelease aRelease) Add a new release at the end.
void	addRelease(int nIndex, ChangeLogRelease aRelease) Add a new release at the specified index.
boolean	equals(Object o)
List<AbstractChangeLogEntry>	getAllBaseEntries()
List<ChangeLogEntry>	getAllEntries()
List<ChangeLogEntry>	getAllEntriesOfCategory(EChangeLogCategory eCategory) Get all change log entries, that match the specified category.
List<ChangeLogRelease>	getAllReleases()
String	getComponent()
ChangeLogRelease	getLatestRelease()
String	getOriginalVersion()
Version	getVersion()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeLog

public ChangeLog(@Nonnull@Nonempty
         String sVersion,
         @Nonnull@Nonempty
         String sComponent)

Constructor.

Parameters:

sVersion - The change log version string.

sComponent - The name of the component the changelog belongs to.

Method Detail

getOriginalVersion

@Nonnull
@Nonempty
public String getOriginalVersion()

Returns:

The original change log version. Never null.

getVersion

@Nonnull
public Version getVersion()

Returns:

The change log version. Never null.

getComponent

@Nonnull
@Nonempty
public String getComponent()

Returns:

The name of the component, to which this change log belongs. Neither null nor empty.

addEntry

public void addEntry(@Nonnull
            ChangeLogEntry aEntry)

Add a new change log entry at the end.

Parameters:

aEntry - The entry to be added. May not be null.

addEntry

public void addEntry(@Nonnegative
            int nIndex,
            @Nonnull
            ChangeLogEntry aEntry)

Add a new change log entry at the specified index.

Parameters:

nIndex - The index to add the change log entry. May not be < 0.

aEntry - The entry to be added. May not be null.

getAllBaseEntries

@Nonnull
@ReturnsMutableCopy
public List<AbstractChangeLogEntry> getAllBaseEntries()

Returns:

An copy of the list with all contained change log items. Never null. The elements my be of type ChangeLogEntry or ChangeLogRelease.

getAllEntries

@Nonnull
@ReturnsMutableCopy
public List<ChangeLogEntry> getAllEntries()

Returns:

A modifiable list of all change log entries. Never null.

getAllEntriesOfCategory

@Nonnull
@ReturnsMutableCopy
public List<ChangeLogEntry> getAllEntriesOfCategory(@Nonnull
                                                                      EChangeLogCategory eCategory)

Get all change log entries, that match the specified category.

Parameters:

eCategory - The category to search. May not be null.

Returns:

An empty list, if no change log entry matched the specified category. Never null.

addRelease

public void addRelease(@Nonnull
              ChangeLogRelease aRelease)

Add a new release at the end.

Parameters:

aRelease - The release to be added. May not be null.

addRelease

public void addRelease(@Nonnegative
              int nIndex,
              @Nonnull
              ChangeLogRelease aRelease)

Add a new release at the specified index.

Parameters:

nIndex - The index to add the release. May not be < 0.

aRelease - The release to be added. May not be null.

getAllReleases

@Nonnull
@ReturnsMutableCopy
public List<ChangeLogRelease> getAllReleases()

Returns:

A list of all contained releases in this change log.

getLatestRelease

@Nullable
public ChangeLogRelease getLatestRelease()

Returns:

The release with the latest date. May be null if no release is contained.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object