opengrok/history/HistoryEntry.java

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright 2006 Trond Norbye.  All rights reserved.
 * Use is subject to license terms.
 */
package org.opensolaris.opengrok.history;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Collect all information of a given revision
 *
 * @author Trond Norbye
 */
public class HistoryEntry {
    private String revision;
    private String oldRevision;
    private Date date;
    private String author;

    @SuppressWarnings("PMD.AvoidStringBufferField")
    private final StringBuffer message;

    private boolean active;
    private SortedSet<String> files;
    private List<String> changeRequests;

    /** Creates a new instance of HistoryEntry */
    public HistoryEntry() {
        message = new StringBuffer();
        files = new TreeSet<String>();
        changeRequests = new ArrayList<String>();
    }

    /**
     * Convinience constructor to create a more or less fully populated entry.
     * @param revision      revision ID of the changeset.
     * @param oldRevision   revision ID of the changeset in the non-hybrid repo.
     *      Use {@code null} if not available.
     * @param date          change timestamp
     * @param author        the authors name and email-address (if available).
     * @param message       the changeset description.
     * @param active        Use {@code true} to indicate, that this entry is
     *                      fully populated and thus usable by other consumers.
     */
    public HistoryEntry(String revision, String oldRevision, Date date,
        String author, String message, boolean active)
    {
        this.revision = revision;
        this.oldRevision = oldRevision;
        setDate(date);
        this.author = author;
        this.message = new StringBuffer(message);
        this.active = active;
        this.files = new TreeSet<String>();
        this.changeRequests = new ArrayList<String>();
    }

    public String getLine() {
        return revision + " " + date + " " + author + " " + message + "\n";
    }

    public void dump() {
        Logger log = Logger.getLogger(HistoryEntry.class.getName());
        if (!log.isLoggable(Level.FINE)) {
            return;
        }
        log.log(Level.FINE, "HistoryEntry : revision       = {0}", revision);
        log.log(Level.FINE, "HistoryEntry : old revision   = {0}",
            oldRevision == null ? "" : oldRevision);
        log.log(Level.FINE, "HistoryEntry : date           = {0}", date);
        log.log(Level.FINE, "HistoryEntry : author         = {0}", author);
        log.log(Level.FINE, "HistoryEntry : active         = {0}", (active ? "True" : "False"));
        String[] lines = message.toString().split("\n");
        String separator = "=";
        for (String line : lines) {
            log.log(Level.FINE, "HistoryEntry : message        {0} {1}", new Object[]{separator, line});
            separator = ">";
        }
        separator = "=";
        for (String cr : changeRequests) {
            log.log(Level.FINE, "HistoryEntry : changeRequests {0} {1}", new Object[]{separator, cr});
            separator = ">";
        }
        separator = "=";
        for (String file : files) {
            log.log(Level.FINE, "HistoryEntry : files          {0} {1}", new Object[]{separator, file});
            separator = ">";
        }
   }

    public String getAuthor() {
        return author;
    }

    public Date getDate() {
        return (date == null) ? null : (Date) date.clone();
    }

    public String getMessage() {
        return message.toString().trim();
    }

    public String getRevision() {
        return revision;
    }

    /**
     * <p>Get the revision of this changeset in the non-hybrid repository.</p>
     * <p>E.g. If hgsubversion is used to "mirror/sync" a svn
     * repository into a mercurial repository and this entry belongs to a
     * mercurial repository - this method returns the svn based revision number,
     * whereby {@link #getRevision()} returns the mercurial revision number.
     *</p>
     * @return {@code null} if not available (e.g. if this is not a hybrid
     *      repo), the non-hybrid revision number otherwise.
     * @see #setOldRevision()
     */
    public String getOldRevision() {
        return oldRevision;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public final void setDate(Date date) {
        if (date == null) {
            this.date = null;
        } else {
            this.date = (Date) date.clone();
        }
    }

    public boolean isActive() {
        return active;
    }

    public void setActive(boolean active) {
        this.active = active;
    }

    public void setMessage(String message) {
        this.message.setLength(0);
        this.message.append(message);
    }

    public void setRevision(String revision) {
        this.revision = revision;
    }

    /**
     * Set the revision of this changeset in the non-hybrid repository.
     * @param revision  revision to set.
     * @see #getOldRevision()
     */
    public void setOldRevision(String revision) {
        this.oldRevision = revision;
    }

    public void appendMessage(String message) {
        this.message.append(message);
        this.message.append("\n");
    }

    public void addFile(String file) {
        files.add(file);
    }

    public SortedSet<String> getFiles() {
        return files;
    }

    public void setFiles(SortedSet<String> files) {
        this.files = files;
    }

    @Override
    public String toString() {
        return getLine();
    }

    public void addChangeRequest(String changeRequest) {
        if (!changeRequests.contains(changeRequest)) {
            changeRequests.add(changeRequest);
        }
    }

    public List<String> getChangeRequests() {
        return changeRequests;
    }

    public void setChangeRequests(List<String> changeRequests) {
        this.changeRequests = changeRequests;
    }

    /**
     * Remove "unneeded" info such as multiline history and files list
     */
    public void strip() {
        files.clear();
    }
}