content: /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements. See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License. You may obtain a copy of the License at
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.kafka.streams.query.internals;
  
  
  import org.apache.kafka.streams.query.FailureReason;
  import org.apache.kafka.streams.query.QueryResult;
  import org.apache.kafka.streams.query.StateQueryRequest;
  
  /**
   * Container for a single partition's result when executing a {@link StateQueryRequest}.
   *
   * @param <R> The result type of the query.
   */
  public final class FailedQueryResult<R>
      extends AbstractQueryResult<R>
      implements QueryResult<R> {
  
      private final FailureReason failureReason;
      private final String failure;
  
      public FailedQueryResult(final FailureReason failureReason, final String failure) {
          this.failureReason = failureReason;
          this.failure = failure;
      }
  
      /**
       * True iff the query was successfully executed. The response is available in {@link
       * this#getResult()}.
       */
      public boolean isSuccess() {
          return false;
      }
  
  
      /**
       * True iff the query execution failed. More information about the failure is available in
       * {@link this#getFailureReason()} and {@link this#getFailureMessage()}.
       */
      public boolean isFailure() {
          return true;
      }
  
      /**
       * If this partition failed to execute the query, returns the reason.
       *
       * @throws IllegalArgumentException if this is not a failed result.
       */
      public FailureReason getFailureReason() {
          return failureReason;
      }
  
      /**
       * If this partition failed to execute the query, returns the failure message.
       *
       * @throws IllegalArgumentException if this is not a failed result.
       */
      public String getFailureMessage() {
          return failure;
      }
  
      /**
       * Returns the result of executing the query on one partition. The result type is determined by
       * the query. Note: queries may choose to return {@code null} for a successful query, so {@link
       * this#isSuccess()} and {@link this#isFailure()} must be used to determine whether the query
       * was successful of failed on this partition.
       *
       * @throws IllegalArgumentException if this is not a successful query.
       */
      public R getResult() {
          throw new IllegalArgumentException(
              "Cannot get result for failed query. Failure is " + failureReason.name() + ": "
                  + failure);
      }
  
      @Override
      public String toString() {
          return "FailedQueryResult{" +
              "failureReason=" + failureReason +
              ", failure='" + failure + '\'' +
              ", executionInfo=" + getExecutionInfo() +
              ", position=" + getPosition() +
              '}';
      }
  }
  