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