org.jboss.dna.connector.federation.contribution
Class PlaceholderContribution

java.lang.Object
  org.jboss.dna.connector.federation.contribution.Contribution
      org.jboss.dna.connector.federation.contribution.NonEmptyContribution
          org.jboss.dna.connector.federation.contribution.MultiChildContribution
              org.jboss.dna.connector.federation.contribution.PlaceholderContribution

All Implemented Interfaces:

Serializable

@Immutable
public class PlaceholderContribution
extends MultiChildContribution

A placeholder contribution needed because of a source's contribution below the specified children.

Author:

Randall Hauch

See Also:

Serialized Form

Constructor Summary

PlaceholderContribution(String sourceName, Location locationInSource, DateTime expirationTime, Iterable<Location> children)
Create a contribution of children from the source with the supplied name.

Method Summary

boolean

isPlaceholder() Determine whether this contribution is considered a placeholder necessary solely because the same source has contributions at or below the children.

Methods inherited from class org.jboss.dna.connector.federation.contribution.MultiChildContribution

getChildren, getChildrenCount

Methods inherited from class org.jboss.dna.connector.federation.contribution.NonEmptyContribution

equals, getLocationInSource, hashCode

Methods inherited from class org.jboss.dna.connector.federation.contribution.Contribution

create, create, create, create, create, createPlaceholder, createPlaceholder, getExpirationTimeInUtc, getProperties, getProperty, getPropertyCount, getSourceName, isEmpty, isExpired, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PlaceholderContribution

public PlaceholderContribution(String sourceName,
                               Location locationInSource,
                               DateTime expirationTime,
                               Iterable<Location> children)

Create a contribution of children from the source with the supplied name.

Parameters:

sourceName - the name of the source, which may not be null or blank

locationInSource - the location in the source for this contributed information; may not be null

expirationTime - the time (in UTC) after which this contribution should be considered expired, or null if there is no expiration time

children - the children from the source; may not be null or empty

Method Detail

isPlaceholder

public boolean isPlaceholder()

Determine whether this contribution is considered a placeholder necessary solely because the same source has contributions at or below the children.

Overrides:

isPlaceholder in class Contribution

Returns:

true if a placeholder contribution, or false otherwise

See Also:

Contribution.isPlaceholder()