• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ReasonPhraseCatalog.java $
3  * $Revision: 505744 $
4  * $Date: 2007-02-10 10:58:45 -0800 (Sat, 10 Feb 2007) $
5  *
6  * ====================================================================
7  * Licensed to the Apache Software Foundation (ASF) under one
8  * or more contributor license agreements.  See the NOTICE file
9  * distributed with this work for additional information
10  * regarding copyright ownership.  The ASF licenses this file
11  * to you under the Apache License, Version 2.0 (the
12  * "License"); you may not use this file except in compliance
13  * with the License.  You may obtain a copy of the License at
14  *
15  *   http://www.apache.org/licenses/LICENSE-2.0
16  *
17  * Unless required by applicable law or agreed to in writing,
18  * software distributed under the License is distributed on an
19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20  * KIND, either express or implied.  See the License for the
21  * specific language governing permissions and limitations
22  * under the License.
23  * ====================================================================
24  *
25  * This software consists of voluntary contributions made by many
26  * individuals on behalf of the Apache Software Foundation.  For more
27  * information on the Apache Software Foundation, please see
28  * <http://www.apache.org/>.
29  *
30  */
31 
32 package org.apache.http;
33 
34 import java.util.Locale;
35 
36 
37 /**
38  * Interface for obtaining reason phrases for HTTP status codes.
39  *
40  * @author <a href="mailto:rolandw at apache.org">Roland Weber</a>
41  *
42  *
43  * <!-- empty lines above to avoid 'svn diff' context problems -->
44  * @version $Revision: 505744 $
45  *
46  * @since 4.0
47  */
48 public interface ReasonPhraseCatalog {
49 
50     /**
51      * Obtains the reason phrase for a status code.
52      * The optional context allows for catalogs that detect
53      * the language for the reason phrase.
54      *
55      * @param status    the status code, in the range 100-599
56      * @param loc       the preferred locale for the reason phrase
57      *
58      * @return  the reason phrase, or <code>null</code> if unknown
59      */
getReason(int status, Locale loc)60     public String getReason(int status, Locale loc)
61         ;
62 
63 }
64