1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http;
29
30 import java.util.Locale;
31
32 /**
33 * Interface for obtaining reason phrases for HTTP status codes.
34 *
35 * @since 4.0
36 */
37 public interface ReasonPhraseCatalog {
38
39 /**
40 * Obtains the reason phrase for a status code.
41 * The optional context allows for catalogs that detect
42 * the language for the reason phrase.
43 *
44 * @param status the status code, in the range 100-599
45 * @param loc the preferred locale for the reason phrase
46 *
47 * @return the reason phrase, or {@code null} if unknown
48 */
49 String getReason(int status, Locale loc);
50
51 }