/*
 * 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.juneau.http.response;

import static org.apache.juneau.http.response.Gone.*;

import java.text.*;
import java.util.*;

import org.apache.http.*;
import org.apache.http.Header;
import org.apache.juneau.annotation.*;
import org.apache.juneau.http.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.http.header.*;
import org.apache.juneau.internal.*;

/**
 * Exception representing an HTTP 410 ().
 *
 * <p>
 * Indicates that the resource requested is no longer available and will not be available again.
 * <br>This should be used when a resource has been intentionally removed and the resource should be purged.
 * <br>Upon receiving a 410 status code, the client should not request the resource in the future.
 * <br>Clients such as search engines should remove the resource from their indices.
 * <br>Most use cases do not require clients and search engines to purge the resource, and a <js>"404 Not Found"</js> may be used instead.
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauRestCommonBasics">juneau-rest-common Basics</a>
 * </ul>
 *
 * @serial exclude
 */
@Response
@StatusCode(STATUS_CODE)
@Schema(description=REASON_PHRASE)
public class Gone extends BasicHttpException {
   private static final long serialVersionUID = 1L;

   /** HTTP status code */
   public static final int STATUS_CODE = 410;

   /** Reason phrase */
   public static final String REASON_PHRASE = "Gone";

   /** Default status line */
   private static final BasicStatusLine STATUS_LINE = BasicStatusLine.create(STATUS_CODE, REASON_PHRASE);

   /** Reusable unmodifiable instance */
   public static final Gone INSTANCE = new Gone().setUnmodifiable();

   /**
    * Constructor.
    *
    * @param cause The caused-by exception.  Can be <jk>null</jk>.
    * @param msg The message.  Can be <jk>null</jk>.
    * @param args The message arguments.
    */
   public Gone(Throwable cause, String msg, Object...args) {
      super(STATUS_CODE, cause, msg, args);
      setStatusLine(STATUS_LINE.copy());
   }

   /**
    * Constructor.
    */
   public Gone() {
      this((Throwable)null, REASON_PHRASE);
   }

   /**
    * Constructor.
    *
    * @param msg The message.  Can be <jk>null</jk>.
    * @param args Optional {@link MessageFormat}-style arguments in the message.
    */
   public Gone(String msg, Object...args) {
      this((Throwable)null, msg, args);
   }

   /**
    * Constructor.
    *
    * @param cause The cause.  Can be <jk>null</jk>.
    */
   public Gone(Throwable cause) {
      this(cause, cause == null ? REASON_PHRASE : cause.getMessage());
   }

   /**
    * Constructor.
    *
    * <p>
    * This is the constructor used when parsing an HTTP response.
    *
    * @param response The HTTP response to copy from.  Must not be <jk>null</jk>.
    * @throws AssertionError If HTTP response status code does not match what was expected.
    */
   public Gone(HttpResponse response) {
      super(response);
      assertStatusCode(response);
   }

   /**
    * Copy constructor.
    *
    * @param copyFrom The bean to copy.
    */
   protected Gone(Gone copyFrom) {
      super(copyFrom);
   }

   /**
    * Creates a modifiable copy of this bean.
    *
    * @return A new modifiable bean.
    */
   public Gone copy() {
      return new Gone(this);
   }
   @Override /* Overridden from BasicRuntimeException */
   public Gone setMessage(String message, Object...args) {
      super.setMessage(message, args);
      return this;
   }

   @Override /* Overridden from BasicRuntimeException */
   public Gone setUnmodifiable() {
      super.setUnmodifiable();
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setHeader2(String name, Object value) {
      super.setHeader2(name, value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setHeaders(HeaderList value) {
      super.setHeaders(value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setHeaders2(Header...values) {
      super.setHeaders2(values);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setLocale2(Locale value) {
      super.setLocale2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setProtocolVersion(ProtocolVersion value) {
      super.setProtocolVersion(value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setReasonPhrase2(String value) {
      super.setReasonPhrase2(value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setReasonPhraseCatalog(ReasonPhraseCatalog value) {
      super.setReasonPhraseCatalog(value);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setStatusCode2(int code) throws IllegalStateException{
      super.setStatusCode2(code);
      return this;
   }

   @Override /* Overridden from BasicHttpException */
   public Gone setStatusLine(BasicStatusLine value) {
      super.setStatusLine(value);
      return this;
   }
}