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