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 net.jcip.annotations.Immutable;
027    import org.jboss.dna.graph.Location;
028    import org.jboss.dna.graph.property.DateTime;
029    
030    /**
031     * A placeholder contribution needed because of a source's contribution below the specified children.
032     * 
033     * @author Randall Hauch
034     */
035    @Immutable
036    public class PlaceholderContribution extends MultiChildContribution {
037    
038        /**
039         * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
040         */
041        private static final long serialVersionUID = 1L;
042    
043        /**
044         * Create a contribution of children from the source with the supplied name.
045         * 
046         * @param sourceName the name of the source, which may not be null or blank
047         * @param workspaceName the name of the workspace, which may not be null or blank
048         * @param locationInSource the location in the source for this contributed information; may not be null
049         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
050         *        expiration time
051         * @param children the children from the source; may not be null or empty
052         */
053        public PlaceholderContribution( String sourceName,
054                                        String workspaceName,
055                                        Location locationInSource,
056                                        DateTime expirationTime,
057                                        Iterable<Location> children ) {
058            super(sourceName, workspaceName, locationInSource, expirationTime, children);
059        }
060    
061        /**
062         * {@inheritDoc}
063         * 
064         * @see org.jboss.dna.connector.federation.contribution.Contribution#isPlaceholder()
065         */
066        @Override
067        public boolean isPlaceholder() {
068            return true;
069        }
070    }