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