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    
031    /**
032     * The record of a source contributing only a single child to a node.
033     * 
034     * @author Randall Hauch
035     */
036    @Immutable
037    public class OneChildContribution 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 Location child;
045    
046        /**
047         * Create a contribution of a single child 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 workspaceName the name of the workspace, which may not be null or blank
051         * @param locationInSource the location 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 child the child contributed from the source; may not be null
055         */
056        public OneChildContribution( String sourceName,
057                                     String workspaceName,
058                                     Location locationInSource,
059                                     DateTime expirationTime,
060                                     Location child ) {
061            super(sourceName, workspaceName, locationInSource, expirationTime);
062            assert child != null;
063            this.child = child;
064            if (ContributionStatistics.RECORD) ContributionStatistics.record(0, 1);
065        }
066    
067        /**
068         * {@inheritDoc}
069         * 
070         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildren()
071         */
072        @Override
073        public Iterator<Location> getChildren() {
074            return new OneValueIterator<Location>(child);
075        }
076    
077        /**
078         * {@inheritDoc}
079         * 
080         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildrenCount()
081         */
082        @Override
083        public int getChildrenCount() {
084            return 1;
085        }
086    
087    }