com.servicerocket.confluence.randombits.metadata.reference.AttachmentReference Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
There is a newer version: 2.5.12
/*
 * Copyright (c) 2005, David Peterson 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 * 			 notice, this list of conditions and the following disclaimer in the
 *   		 documentation and/or other materials provided with the distribution.
 *     * Neither the name of "randombits.org" nor the names of its contributors
 * 			 may be used to endorse or promote products derived from this software
 * 			 without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * v1.0: Created on Oct 14, 2005 by David Peterson
 */
package com.servicerocket.confluence.randombits.metadata.reference;

import com.atlassian.confluence.pages.Attachment;
import org.apache.commons.lang.builder.EqualsBuilder;

/**
 * 
 * @author David Peterson
 */
public class AttachmentReference implements Reference {

    private static final long serialVersionUID = -5813410421929121716L;

    private long contentId;

    private long attachmentId;

    private String filename;

    /**
     * Default constructor. Only intended for use by XStream.
     */
    public AttachmentReference() {}

    /**
     * @param att
     *            The attachment.
     */
    public AttachmentReference(Attachment att) {
        contentId = att.getContainer() != null ? att.getContainer().getId() : -1;
        attachmentId = att.getId();
        filename = att.getFileName();
    }

    public long getContentId() {
        return contentId;
    }

    public long getAttachmentId() {
        return attachmentId;
    }

    public String getFileName() {
        return filename;
    }

    /**
     * Checks if the specified object is equal to this one.
     * 
     * @param obj
     *            The object to test.
     * @return true if the object is a ContentItem and its id is
     *         equal to this object's id.
     * @see Object#equals(Object)
     */
    @Override public boolean equals(Object obj) {
        if (obj instanceof AttachmentReference) {
            AttachmentReference ci = (AttachmentReference) obj;

            return new EqualsBuilder().append(contentId, ci.contentId).append(attachmentId, ci.attachmentId).append(filename, ci.filename).isEquals();
        }
        return false;
    }

    /**
     * @return the hash code for the list option.
     * @see Object#hashCode()
     */
    @Override public int hashCode() {
        return 23 + (int) contentId;
    }

    /**
     * @return the string values of the option.
     * @see Object#toString()
     */
    @Override public String toString() {
        return Long.toString(contentId);
    }
}