Package cloud.commandframework.services

Class ChunkedRequestContext<Context,​Result>

  • Type Parameters:
    Context - Context/Request type
    Result - Result type
    public abstract class ChunkedRequestContext<@NonNull Context,​@NonNull Result>
extends java.lang.Object
    This class represents a request that can be fulfilled by one, or multiple services, for one or more objects

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ChunkedRequestContext​(@NonNull java.util.Collection<@NonNull Context> requests)
      Initialize a new request

    • Method Summary

      Modifier and Type Method Description
      @NonNull java.util.Map<@NonNull Context,​@NonNull Result> getAvailableResults()
      Get a view of the (currently) available results
      @NonNull java.util.List<@NonNull Context> getRemaining()
      Get all remaining requests
      boolean isCompleted()
      Check if the request has been completed
      void storeResult​(@NonNull Context context, @NonNull Result result)
      Store a result for a specific context

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ChunkedRequestContext

        protected ChunkedRequestContext​(@NonNull java.util.Collection<@NonNull Context> requests)
        Initialize a new request
        Parameters:
        requests - Request contexts

    • Method Detail

      • getAvailableResults

        public final @NonNull java.util.Map<@NonNull Context,​@NonNull Result> getAvailableResults()
        Get a view of the (currently) available results
        Returns:
        Unmodifiable map of results

      • getRemaining

        public final @NonNull java.util.List<@NonNull Context> getRemaining()
        Get all remaining requests
        Returns:
        Unmodifiable list of remaining requests

      • storeResult

        public final void storeResult​(@NonNull Context context,
                              @NonNull Result result)
        Store a result for a specific context
        Parameters:
        context - Context
        result - Result

      • isCompleted

        public final boolean isCompleted()
        Check if the request has been completed
        Returns:
        true if the request has been completed, false if not