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 java.util.Iterator;
027    import net.jcip.annotations.Immutable;
028    import org.jboss.dna.graph.Location;
029    import org.jboss.dna.graph.property.DateTime;
030    import org.jboss.dna.graph.property.Name;
031    import org.jboss.dna.graph.property.Property;
032    
033    /**
034     * The record of a source contributing only properties to a node.
035     * 
036     * @author Randall Hauch
037     */
038    @Immutable
039    public class TwoPropertyContribution extends NonEmptyContribution {
040    
041        /**
042         * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
043         */
044        private static final long serialVersionUID = 1L;
045    
046        private final Property property1;
047        private final Property property2;
048    
049        /**
050         * Create a contribution of node properties from the source with the supplied name.
051         * 
052         * @param sourceName the name of the source, which may not be null or blank
053         * @param workspaceName the name of the workspace, which may not be null or blank
054         * @param locationInSource the path in the source for this contributed information; may not be null
055         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
056         *        expiration time
057         * @param property1 the first property from the source; may not be null
058         * @param property2 the first property from the source; may not be null
059         */
060        public TwoPropertyContribution( String sourceName,
061                                        String workspaceName,
062                                        Location locationInSource,
063                                        DateTime expirationTime,
064                                        Property property1,
065                                        Property property2 ) {
066            super(sourceName, workspaceName, locationInSource, expirationTime);
067            assert property1 != null;
068            assert property1.isEmpty() == false;
069            assert property2 != null;
070            assert property2.isEmpty() == false;
071            this.property1 = property1;
072            this.property2 = property2;
073            if (ContributionStatistics.RECORD) ContributionStatistics.record(2, 0);
074        }
075    
076        /**
077         * {@inheritDoc}
078         * 
079         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperties()
080         */
081        @Override
082        public Iterator<Property> getProperties() {
083            return new TwoValueIterator<Property>(property1, property2);
084        }
085    
086        /**
087         * {@inheritDoc}
088         * 
089         * @see org.jboss.dna.connector.federation.contribution.Contribution#getPropertyCount()
090         */
091        @Override
092        public int getPropertyCount() {
093            return 2;
094        }
095    
096        /**
097         * {@inheritDoc}
098         * 
099         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperty(org.jboss.dna.graph.property.Name)
100         */
101        @Override
102        public Property getProperty( Name name ) {
103            if (this.property1.getName().equals(name)) return property1;
104            if (this.property2.getName().equals(name)) return property2;
105            return null;
106        }
107    
108    }