com.helger.commons.changelog

Class ChangeLog

java.lang.Object

com.helger.commons.changelog.ChangeLog

All Implemented Interfaces:

Serializable

Deprecated.

@NotThreadSafe
 @Deprecated
public 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) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
ICommonsList<AbstractChangeLogEntry>	entries() Deprecated.
boolean	equals(Object o) Deprecated.
ICommonsList<ChangeLogEntry>	getAllEntries() Deprecated.
ICommonsList<ChangeLogEntry>	getAllEntriesOfCategory(EChangeLogCategory eCategory) Deprecated. Get all change log entries, that match the specified category.
ICommonsList<ChangeLogRelease>	getAllReleases() Deprecated.
String	getComponent() Deprecated.
ChangeLogRelease	getLatestRelease() Deprecated.
String	getOriginalVersion() Deprecated.
Version	getVersion() Deprecated.
int	hashCode() Deprecated.
String	toString() Deprecated.

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)

Deprecated.

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()

Deprecated.

Returns:

The original change log version. Never null.

getVersion

@Nonnull
public Version getVersion()

Deprecated.

Returns:

The change log version. Never null.

getComponent

@Nonnull
 @Nonempty
public String getComponent()

Deprecated.

Returns:

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

entries

@Nonnull
 @ReturnsMutableObject
public ICommonsList<AbstractChangeLogEntry> entries()

Deprecated.

Returns:

The internal modifiable list of entries. Never null.

Since:

9.0.0

getAllEntries

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

Deprecated.

Returns:

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

getAllEntriesOfCategory

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

Deprecated.

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.

getAllReleases

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

Deprecated.

Returns:

A list of all contained releases in this change log.

getLatestRelease

@Nullable
public ChangeLogRelease getLatestRelease()

Deprecated.

Returns:

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

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object