001 /*
002 * JBoss DNA (http://www.jboss.org/dna)
003 * See the COPYRIGHT.txt file distributed with this work for information
004 * regarding copyright ownership. Some portions may be licensed
005 * to Red Hat, Inc. under one or more contributor license agreements.
006 * See the AUTHORS.txt file in the distribution for a full listing of
007 * individual contributors.
008 *
009 * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010 * is licensed to you under the terms of the GNU Lesser General Public License as
011 * published by the Free Software Foundation; either version 2.1 of
012 * the License, or (at your option) any later version.
013 *
014 * JBoss DNA is distributed in the hope that it will be useful,
015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 * Lesser General Public License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this software; if not, write to the Free
021 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023 */
024 package org.jboss.dna.connector.federation.contribution;
025
026 import net.jcip.annotations.Immutable;
027 import org.jboss.dna.common.util.HashCode;
028 import org.jboss.dna.graph.Location;
029 import org.jboss.dna.graph.property.DateTime;
030
031 /**
032 * The record of a non-empty source contribution from a single location within the source.
033 *
034 * @author Randall Hauch
035 */
036 @Immutable
037 public abstract class NonEmptyContribution extends Contribution {
038
039 /**
040 * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
041 */
042 private static final long serialVersionUID = 1L;
043
044 private final Location locationInSource;
045
046 /**
047 * Create a contribution of node properties from the source with the supplied name.
048 *
049 * @param sourceName the name of the source, which may not be null or blank
050 * @param workspaceName the name of the workspace, which may not be null or blank
051 * @param locationInSource the location in the source for this contributed information; may not be null
052 * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
053 * expiration time
054 */
055 protected NonEmptyContribution( String sourceName,
056 String workspaceName,
057 Location locationInSource,
058 DateTime expirationTime ) {
059 super(sourceName, workspaceName, expirationTime);
060 assert locationInSource != null;
061 this.locationInSource = locationInSource;
062 }
063
064 /**
065 * {@inheritDoc}
066 *
067 * @see org.jboss.dna.connector.federation.contribution.Contribution#getLocationInSource()
068 */
069 @Override
070 public Location getLocationInSource() {
071 return locationInSource;
072 }
073
074 /**
075 * {@inheritDoc}
076 * <p>
077 * This implementation returns the hash code of the {@link #getSourceName() source name}, and is compatible with the
078 * implementation of {@link #equals(Object)}.
079 * </p>
080 */
081 @Override
082 public int hashCode() {
083 return HashCode.compute(this.getSourceName(), this.getLocationInSource());
084 }
085
086 /**
087 * {@inheritDoc}
088 */
089 @Override
090 public boolean equals( Object obj ) {
091 if (obj == this) return true;
092 if (obj instanceof NonEmptyContribution) {
093 NonEmptyContribution that = (NonEmptyContribution)obj;
094 if (!this.getSourceName().equals(that.getSourceName())) return false;
095 if (!this.getWorkspaceName().equals(that.getWorkspaceName())) return false;
096 if (!this.getLocationInSource().equals(that.getLocationInSource())) return false;
097 return true;
098 }
099 return false;
100 }
101 }