001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.exception;
014
015import static org.apache.juneau.rest.exception.NotImplemented.*;
016
017import java.text.*;
018
019import org.apache.juneau.http.annotation.*;
020import org.apache.juneau.rest.*;
021
022/**
023 * Exception representing an HTTP 501 (Not Implemented).
024 *
025 * <p>
026 * The server either does not recognize the request method, or it lacks the ability to fulfill the request.
027 * <br>Usually this implies future availability (e.g., a new feature of a web-service API).
028 */
029@Response(code=CODE, description=MESSAGE)
030public class NotImplemented extends RestException {
031   private static final long serialVersionUID = 1L;
032
033   /** HTTP status code */
034   public static final int CODE = 501;
035
036   /** Default message */
037   public static final String MESSAGE = "Not Implemented";
038
039   /**
040    * Constructor.
041    *
042    * @param cause The cause.  Can be <jk>null</jk>.
043    * @param msg The message.  Can be <jk>null</jk>.
044    * @param args Optional {@link MessageFormat}-style arguments in the message.
045    */
046   public NotImplemented(Throwable cause, String msg, Object...args) {
047      super(cause, CODE, msg, args);
048   }
049
050   /**
051    * Constructor.
052    */
053   public NotImplemented() {
054      this((Throwable)null, MESSAGE);
055   }
056
057   /**
058    * Constructor.
059    *
060    * @param msg The message.  Can be <jk>null</jk>.
061    * @param args Optional {@link MessageFormat}-style arguments in the message.
062    */
063   public NotImplemented(String msg, Object...args) {
064      this(null, msg, args);
065   }
066
067   /**
068    * Constructor.
069    *
070    * @param cause The cause.  Can be <jk>null</jk>.
071    */
072   public NotImplemented(Throwable cause) {
073      this(cause, null);
074   }
075}