edu.stanford.protege.webprotege.revision.Revision Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-api Show documentation
There is a newer version: 2.1.0
Show newest version
package edu.stanford.protege.webprotege.revision;

import com.google.common.base.Objects;
import com.google.common.collect.ImmutableList;
import edu.stanford.protege.webprotege.change.OntologyChange;
import edu.stanford.protege.webprotege.common.UserId;

import javax.annotation.Nonnull;
import java.util.Iterator;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 18/07/2013
 */
public class Revision implements Comparable {


    private final UserId userId;

    private final RevisionNumber revisionNumber;

    private final long timestamp;

    private final ImmutableList changes;

    private final String highLevelDescription;

    public Revision(UserId userId, RevisionNumber revisionNumber,
                    ImmutableList changes,
                    long timestamp,
                    String highLevelDescription) {
        this.changes = checkNotNull(changes);
        this.userId = checkNotNull(userId);
        this.revisionNumber = checkNotNull(revisionNumber);
        this.timestamp = timestamp;
        this.highLevelDescription = checkNotNull(highLevelDescription);
    }

    public int getSize() {
        return changes.size();
    }

    public ImmutableList getChanges() {
        return changes;
    }

    public static Revision createEmptyRevisionWithRevisionNumber(RevisionNumber revision) {
        return new Revision(UserId.getGuest(), revision, ImmutableList.of(), 0L, "");
    }

    public long getTimestamp() {
        return timestamp;
    }

    public UserId getUserId() {
        return userId;
    }

    public RevisionNumber getRevisionNumber() {
        return revisionNumber;
    }

    public int compareTo(@Nonnull Revision o) {
        return this.revisionNumber.compareTo(o.revisionNumber);
    }

    public String getHighLevelDescription() {
        return highLevelDescription != null ? highLevelDescription : "";
    }

    @Nonnull
    public Iterator iterator() {
        return changes.iterator();
    }


    @Override
    public String toString() {
        return toStringHelper("Revision")
                .addValue(revisionNumber)
                .addValue(userId)
                .add("timestamp", timestamp)
                .add("description", highLevelDescription)
                .add("changes", changes.size())
                .toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof Revision)) {
            return false;
        }
        Revision other = (Revision) obj;
        return this.userId.equals(other.userId)
                && this.revisionNumber.equals(other.revisionNumber)
                && this.timestamp == other.timestamp
                && this.highLevelDescription.equals(other.highLevelDescription)
                && this.changes.equals(other.changes);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(userId, revisionNumber, timestamp, highLevelDescription, changes);
    }
}