com.phloc.commons.changelog.ChangeLog Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.commons.changelog;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.collections.ContainerHelper;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.commons.version.Version;
/**
* This class represents a single change log with a list of entries and
* releases.
*
* @author Philip Helger
*/
@NotThreadSafe
public final class ChangeLog implements Serializable
{
private final String m_sOriginalVersion;
private final Version m_aVersion;
private final String m_sComponent;
private final List m_aEntries = new ArrayList ();
/**
* Constructor.
*
* @param sVersion
* The change log version string.
* @param sComponent
* The name of the component the changelog belongs to.
*/
public ChangeLog (@Nonnull @Nonempty final String sVersion, @Nonnull @Nonempty final String sComponent)
{
m_sOriginalVersion = ValueEnforcer.notEmpty (sVersion, "Version");
m_aVersion = new Version (sVersion);
m_sComponent = ValueEnforcer.notEmpty (sComponent, "Component");
}
/**
* @return The original change log version. Never null.
*/
@Nonnull
@Nonempty
public String getOriginalVersion ()
{
return m_sOriginalVersion;
}
/**
* @return The change log version. Never null.
*/
@Nonnull
public Version getVersion ()
{
return m_aVersion;
}
/**
* @return The name of the component, to which this change log belongs.
* Neither null nor empty.
*/
@Nonnull
@Nonempty
public String getComponent ()
{
return m_sComponent;
}
/**
* Add a new change log entry at the end.
*
* @param aEntry
* The entry to be added. May not be null.
*/
public void addEntry (@Nonnull final ChangeLogEntry aEntry)
{
ValueEnforcer.notNull (aEntry, "Entry");
m_aEntries.add (aEntry);
}
/**
* Add a new change log entry at the specified index.
*
* @param nIndex
* The index to add the change log entry. May not be < 0.
* @param aEntry
* The entry to be added. May not be null.
*/
public void addEntry (@Nonnegative final int nIndex, @Nonnull final ChangeLogEntry aEntry)
{
ValueEnforcer.notNull (aEntry, "Entry");
m_aEntries.add (nIndex, aEntry);
}
/**
* @return An copy of the list with all contained change log items. Never
* null. The elements my be of type
* {@link ChangeLogEntry} or {@link ChangeLogRelease}.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllBaseEntries ()
{
return ContainerHelper.newList (m_aEntries);
}
/**
* @return A modifiable list of all change log entries. Never
* null.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllEntries ()
{
final List ret = new ArrayList ();
for (final AbstractChangeLogEntry aEntry : m_aEntries)
if (aEntry instanceof ChangeLogEntry)
ret.add ((ChangeLogEntry) aEntry);
return ret;
}
/**
* Get all change log entries, that match the specified category.
*
* @param eCategory
* The category to search. May not be null.
* @return An empty list, if no change log entry matched the specified
* category. Never null.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllEntriesOfCategory (@Nonnull final EChangeLogCategory eCategory)
{
ValueEnforcer.notNull (eCategory, "Category");
final List ret = new ArrayList ();
for (final AbstractChangeLogEntry aEntry : m_aEntries)
if (aEntry instanceof ChangeLogEntry)
{
final ChangeLogEntry aRealEntry = (ChangeLogEntry) aEntry;
if (aRealEntry.getCategory ().equals (eCategory))
ret.add (aRealEntry);
}
return ret;
}
/**
* Add a new release at the end.
*
* @param aRelease
* The release to be added. May not be null.
*/
public void addRelease (@Nonnull final ChangeLogRelease aRelease)
{
ValueEnforcer.notNull (aRelease, "Release");
m_aEntries.add (aRelease);
}
/**
* Add a new release at the specified index.
*
* @param nIndex
* The index to add the release. May not be < 0.
* @param aRelease
* The release to be added. May not be null.
*/
public void addRelease (@Nonnegative final int nIndex, @Nonnull final ChangeLogRelease aRelease)
{
ValueEnforcer.notNull (aRelease, "Release");
m_aEntries.add (nIndex, aRelease);
}
/**
* @return A list of all contained releases in this change log.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllReleases ()
{
final List ret = new ArrayList ();
for (final AbstractChangeLogEntry aEntry : m_aEntries)
if (aEntry instanceof ChangeLogRelease)
ret.add ((ChangeLogRelease) aEntry);
return ret;
}
/**
* @return The release with the latest date. May be null if no
* release is contained.
*/
@Nullable
public ChangeLogRelease getLatestRelease ()
{
ChangeLogRelease aLatest = null;
for (final AbstractChangeLogEntry aEntry : m_aEntries)
if (aEntry instanceof ChangeLogRelease)
{
final ChangeLogRelease aRelease = (ChangeLogRelease) aEntry;
if (aLatest == null || aRelease.getDate ().getTime () > aLatest.getDate ().getTime ())
aLatest = aRelease;
}
return aLatest;
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (!(o instanceof ChangeLog))
return false;
final ChangeLog rhs = (ChangeLog) o;
return m_sOriginalVersion.equals (rhs.m_sOriginalVersion) &&
m_aVersion.equals (rhs.m_aVersion) &&
m_sComponent.equals (rhs.m_sComponent) &&
m_aEntries.equals (rhs.m_aEntries);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_sOriginalVersion)
.append (m_aVersion)
.append (m_sComponent)
.append (m_aEntries)
.getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("originalVersion", m_sOriginalVersion)
.append ("version", m_aVersion)
.append ("component", m_sComponent)
.append ("entries", m_aEntries)
.toString ();
}
}