com.helger.commons.changelog

Class ChangeLogEntry

java.lang.Object

com.helger.commons.changelog.AbstractChangeLogEntry

com.helger.commons.changelog.ChangeLogEntry

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class ChangeLogEntry
extends AbstractChangeLogEntry

This class represents a single entry in the changelog.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChangeLogEntry(ChangeLog aChangeLog, Date aDate, EChangeLogAction eAction, EChangeLogCategory eCategory, boolean bIsIncompatible) Constructor.

Method Summary

Modifier and Type	Method and Description
EChange	addIssue(String sIssue) Add a new issue ID to this entry.
boolean	equals(Object o)
EChangeLogAction	getAction()
List<String>	getAllIssues()
IMultilingualText	getAllTexts()
EChangeLogCategory	getCategory()
ChangeLog	getChangeLog()
String	getText(Locale aContentLocale) Get the text of the specified locale.
int	hashCode()
boolean	isIncompatible()
EChange	setText(Locale aContentLocale, String sText) Set the change text of this entry in the specified locale.
String	toString()

Methods inherited from class com.helger.commons.changelog.AbstractChangeLogEntry

getDate

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeLogEntry

public ChangeLogEntry(@Nonnull
                      ChangeLog aChangeLog,
                      @Nonnull
                      Date aDate,
                      @Nonnull
                      EChangeLogAction eAction,
                      @Nonnull
                      EChangeLogCategory eCategory,
                      boolean bIsIncompatible)

Constructor.

Parameters:

aChangeLog - The owning changelog object. May not be null.

aDate - The issue date of the change log entry. May not be null .

eAction - The action that was performed. May not be null.

eCategory - The category to which the entry belongs. May not be null.

bIsIncompatible - true if the change has known incompatibility

Method Detail

getChangeLog

@Nonnull
public ChangeLog getChangeLog()

Returns:

The owning changelog. Never null.

getAction

@Nonnull
public EChangeLogAction getAction()

Returns:

The action that was performed. Never null.

getCategory

@Nonnull
public EChangeLogCategory getCategory()

Returns:

The category to which the action belongs. Never null.

isIncompatible

public boolean isIncompatible()

Returns:

true if this changelog entry is about a change that has known incompatibility

setText

@Nonnull
public EChange setText(@Nonnull
                                 Locale aContentLocale,
                                 @Nullable
                                 String sText)

Set the change text of this entry in the specified locale.

Parameters:

aContentLocale - The locale of the change.

sText - The text to be set. If the text is null or empty the call is ignored.

Returns:

EChange

getAllTexts

@Nonnull
 @ReturnsMutableCopy
public IMultilingualText getAllTexts()

Returns:

A new multilingual text containing all change texts of this entry.

getText

@Nullable
public String getText(@Nonnull
                                 Locale aContentLocale)

Get the text of the specified locale.

Parameters:

aContentLocale - The locale to query. May not be null.

Returns:

null if no such text is contained.

addIssue

@Nonnull
public EChange addIssue(@Nullable
                                  String sIssue)

Add a new issue ID to this entry.

Parameters:

sIssue - The issue ID to be added. If it is null or empty, the call is ignored.

Returns:

EChange

getAllIssues

@Nonnull
 @ReturnsMutableCopy
public List<String> getAllIssues()

Returns:

A non-null list of all contained issue IDs.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractChangeLogEntry

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractChangeLogEntry

toString

public String toString()

Overrides:

toString in class AbstractChangeLogEntry