Interface Resources<T extends Resource>

Type Parameters:
T - the contained type
All Superinterfaces:
Resource
All Known Subinterfaces:
ClassTree, DocumentationDirectory, FileTree<T>, InputTree<T>, JavadocDirectory, JavaResourceTree
All Known Implementing Classes:
DefaultClassTree, DefaultFileTree, DefaultJavaResourceTree, DefaultResources, ZipFileInputTree
public interface Resources<T extends Resource> extends Resource
Defines a container for a collection of resources. Implementations must behave as sets (no duplicate entries) and must maintain insertion order when providing the content through stream().

  • Method Details

    • add

      Resources<T> add(T resource)
      Adds the given resource.
      Parameters:
      resource - the resource
      Returns:
      the resources

    • addAll

      default Resources<T> addAll(Resources<? extends T> resources)
      Adds all resources from the given collection.
      Parameters:
      resources - the resources to add
      Returns:
      the resources

    • addAll

      default Resources<T> addAll(Stream<? extends T> resources)
      Adds all resources from the given stream. This consumes the given stream.
      Parameters:
      resources - the resources to add
      Returns:
      the resources

    • asOf

      default Optional<Instant> asOf()
      Description copied from interface: Resource
      The instant at which this resource was created or last modified.
      Specified by:
      asOf in interface Resource
      Returns:
      the instant, if available

    • isEmpty

      default boolean isEmpty()
      Checks if is empty. The default implementation returns get().isEmpty(). Implementing classes should provide a more efficient implementation.
      Returns:
      true, if is empty

    • get

      SequencedSet<T> get()
      Returns the resources as a SequencedSet.
      Returns:
      the sequenced set

    • stream

      default Stream<T> stream()
      Retrieves the resources as a stream.
      Returns:
      the stream

    • clear

      Resources<T> clear()
      Clears the contained resources.
      Returns:
      the resources

    • with

      static <T extends Resource> Resources<T> with(Class<T> type)
      Creates a new resource container with elements of the given type.
      Type Parameters:
      T - the generic type
      Parameters:
      type - the type
      Returns:
      the resources container

    • with

      static <T extends Resource> Resources<T> with(ResourceType<T> type)
      Creates a new resource container with elements of the given type.
      Type Parameters:
      T - the generic type
      Parameters:
      type - the type
      Returns:
      the resources container

    • of

      static <T extends Resource> T of(ResourceType<T> type)
      Creates a new resource container with the specified type.
      Type Parameters:
      T - the generic type
      Parameters:
      type - the type
      Returns:
      the resources container