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 two children to a node.
033 *
034 * @author Randall Hauch
035 */
036 @Immutable
037 public class TwoChildContribution 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 child1;
045 private final Location child2;
046
047 /**
048 * Create a contribution of two children from the source with the supplied name.
049 *
050 * @param sourceName the name of the source, which may not be null or blank
051 * @param workspaceName the name of the workspace, which may not be null or blank
052 * @param locationInSource the path 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 child1 the first child contributed from the source; may not be null
056 * @param child2 the second child contributed from the source; may not be null
057 */
058 public TwoChildContribution( String sourceName,
059 String workspaceName,
060 Location locationInSource,
061 DateTime expirationTime,
062 Location child1,
063 Location child2 ) {
064 super(sourceName, workspaceName, locationInSource, expirationTime);
065 assert child1 != null;
066 assert child2 != null;
067 this.child1 = child1;
068 this.child2 = child2;
069 if (ContributionStatistics.RECORD) ContributionStatistics.record(0, 2);
070 }
071
072 /**
073 * {@inheritDoc}
074 *
075 * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildren()
076 */
077 @Override
078 public Iterator<Location> getChildren() {
079 return new TwoValueIterator<Location>(child1, child2);
080 }
081
082 /**
083 * {@inheritDoc}
084 *
085 * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildrenCount()
086 */
087 @Override
088 public int getChildrenCount() {
089 return 2;
090 }
091
092 }