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 OnePropertyContribution 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 property;
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 workspaceName the name of the workspace, which may not be null or blank
053         * @param locationInSource the location in the source for this contributed information; may not be null
054         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
055         *        expiration time
056         * @param property the property from the source; may not be null
057         */
058        public OnePropertyContribution( String sourceName,
059                                        String workspaceName,
060                                        Location locationInSource,
061                                        DateTime expirationTime,
062                                        Property property ) {
063            super(sourceName, workspaceName, locationInSource, expirationTime);
064            assert property != null;
065            assert property.isEmpty() == false;
066            this.property = property;
067            if (ContributionStatistics.RECORD) ContributionStatistics.record(1, 0);
068        }
069    
070        /**
071         * {@inheritDoc}
072         * 
073         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperties()
074         */
075        @Override
076        public Iterator<Property> getProperties() {
077            return new OneValueIterator<Property>(property);
078        }
079    
080        /**
081         * {@inheritDoc}
082         * 
083         * @see org.jboss.dna.connector.federation.contribution.Contribution#getPropertyCount()
084         */
085        @Override
086        public int getPropertyCount() {
087            return 1;
088        }
089    
090        /**
091         * {@inheritDoc}
092         * 
093         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperty(org.jboss.dna.graph.property.Name)
094         */
095        @Override
096        public Property getProperty( Name name ) {
097            return this.property.getName().equals(name) ? property : null;
098        }
099    
100    }