/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES  **************
*
*  (c) 2019.                            (c) 2019.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits réservés
*
*  NRC disclaims any warranties,        Le CNRC dénie toute garantie
*  expressed, implied, or               énoncée, implicite ou légale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           être tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou général,
*  arising from the use of the          accessoire ou fortuit, résultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        être utilisés pour approuver ou
*  products derived from this           promouvoir les produits dérivés
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  préalable et particulière
*                                       par écrit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la “GNU Affero General Public
*  License as published by the          License” telle que publiée
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit (à votre gré)
*  any later version.                   toute version ultérieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribué
*  hope that it will be useful,         dans l’espoir qu’il vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans même la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILITÉ
*  or FITNESS FOR A PARTICULAR          ni d’ADÉQUATION À UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Générale Publique GNU Affero
*  more details.                        pour plus de détails.
*
*  You should have received             Vous devriez avoir reçu une
*  a copy of the GNU Affero             copie de la Licence Générale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce n’est
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
*  $Revision: 5 $
*
************************************************************************
*/

package ca.nrc.cadc.caom2.artifact;

import ca.nrc.cadc.caom2.ProductType;
import ca.nrc.cadc.caom2.ReleaseType;

import java.net.URI;
import java.util.Comparator;
import java.util.Date;


/**
 * Class to hold meta information about an artifact.
 * validate mode uses checksum.
 * Other attributes are optional and can be left as null.
 * </p><p>
 *
 * Extra fields marked <em>transient</em> allow applications store the CAOM 
 * values to support application logic and logging. These values are not part 
 * of the state and not expected to be stored and returned by an ArtifactStore 
 * implementation.
 * 
 * @author majorb
 *
 */
public class ArtifactMetadata {
    private final URI artifactURI;
    private final String checksum;
    
    public Long contentLength;
    public String contentType;
    
    public transient ProductType productType;
    public transient ReleaseType releaseType;
    public transient Date dataRelease;
    public transient Date metaRelease;
    public transient String observationID;

    /**
     * Constructor. 
     * @param artifactURI cannot be null
     * @param checksum allowed to be null but highly discouraged!!
     */
    public ArtifactMetadata(URI artifactURI, String checksum) {
        if (artifactURI == null) {
            throw new IllegalArgumentException("artifactURI cannot be null");
        }
        this.artifactURI = artifactURI;
        this.checksum = checksum;
    }

    public URI getArtifactURI() {
        return artifactURI;
    }

    public String getChecksum() {
        return checksum;
    }

    @Override
    public boolean equals(Object o) {
        if (o instanceof ArtifactMetadata) {
            ArtifactMetadata other = (ArtifactMetadata) o;
            Comparator<ArtifactMetadata> comparator = ArtifactMetadata.getComparator();
            return comparator.compare(this, other) == 0;
        }
        return false;
    }
    
    /**
     * Return a comparator that compares artifactURI values.
     * @return comparator
     */
    public static Comparator<ArtifactMetadata> getComparator() {
        return new Comparator<ArtifactMetadata>() {
            @Override
            public int compare(ArtifactMetadata o1, ArtifactMetadata o2) {
                return o1.artifactURI.compareTo(o2.artifactURI);
            }
        };
    }
}

@@ -4259,22 +4259,15 @@
 %0A * 
-%3C/p%3E%3Cp%3E%0A *
 %0A * 
+%3Cp%3E
 Extr

fix javadoc