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 java.util.LinkedList;
028    import java.util.List;
029    import net.jcip.annotations.Immutable;
030    import org.jboss.dna.graph.Location;
031    import org.jboss.dna.graph.property.DateTime;
032    
033    /**
034     * The contribution of a source to the information for a single federated node.
035     * 
036     * @author Randall Hauch
037     */
038    @Immutable
039    public class MultiChildContribution 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 List<Location> children;
047    
048        /**
049         * Create a contribution of children 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 children the children from the source; may not be null or empty
057         */
058        public MultiChildContribution( String sourceName,
059                                       String workspaceName,
060                                       Location locationInSource,
061                                       DateTime expirationTime,
062                                       Iterable<Location> children ) {
063            super(sourceName, workspaceName, locationInSource, expirationTime);
064            assert children != null;
065            this.children = new LinkedList<Location>();
066            for (Location child : children) {
067                if (child != null) this.children.add(child);
068            }
069            assert this.children.isEmpty() == false;
070            if (ContributionStatistics.RECORD) ContributionStatistics.record(0, this.children.size());
071        }
072    
073        /**
074         * {@inheritDoc}
075         * 
076         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildren()
077         */
078        @Override
079        public Iterator<Location> getChildren() {
080            return new ImmutableIterator<Location>(children.iterator());
081        }
082    
083        /**
084         * {@inheritDoc}
085         * 
086         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildrenCount()
087         */
088        @Override
089        public int getChildrenCount() {
090            return children.size();
091        }
092    }