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