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 ThreePropertyContribution 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        private final Property property3;
047    
048        /**
049         * Create a contribution of node properties from the source with the supplied name.
050         * 
051         * @param sourceName the name of the source, which may not be null or blank
052         * @param locationInSource the location in the source for this contributed information; may not be null
053         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
054         *        expiration time
055         * @param property1 the first property from the source; may not be null
056         * @param property2 the second property from the source; may not be null
057         * @param property3 the third property from the source; may not be null
058         */
059        public ThreePropertyContribution( String sourceName,
060                                          Location locationInSource,
061                                          DateTime expirationTime,
062                                          Property property1,
063                                          Property property2,
064                                          Property property3 ) {
065            super(sourceName, locationInSource, expirationTime);
066            assert property1 != null;
067            assert property1.isEmpty() == false;
068            assert property2 != null;
069            assert property2.isEmpty() == false;
070            assert property3 != null;
071            assert property3.isEmpty() == false;
072            this.property1 = property1;
073            this.property2 = property2;
074            this.property3 = property3;
075            if (ContributionStatistics.RECORD) ContributionStatistics.record(3, 0);
076        }
077    
078        /**
079         * {@inheritDoc}
080         * 
081         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperties()
082         */
083        @Override
084        public Iterator<Property> getProperties() {
085            return new ThreeValueIterator<Property>(property1, property2, property3);
086        }
087    
088        /**
089         * {@inheritDoc}
090         * 
091         * @see org.jboss.dna.connector.federation.contribution.Contribution#getPropertyCount()
092         */
093        @Override
094        public int getPropertyCount() {
095            return 3;
096        }
097    
098        /**
099         * {@inheritDoc}
100         * 
101         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperty(org.jboss.dna.graph.properties.Name)
102         */
103        @Override
104        public Property getProperty( Name name ) {
105            if (this.property1.getName().equals(name)) return property1;
106            if (this.property2.getName().equals(name)) return property2;
107            if (this.property3.getName().equals(name)) return property3;
108            return null;
109        }
110    
111    }