Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
StringEncoder |
|
| 1.0;1 |
1 | /* | |
2 | * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 | * contributor license agreements. See the NOTICE file distributed with | |
4 | * this work for additional information regarding copyright ownership. | |
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 | |
6 | * (the "License"); you may not use this file except in compliance with | |
7 | * the License. You may obtain a copy of the License at | |
8 | * | |
9 | * http://www.apache.org/licenses/LICENSE-2.0 | |
10 | * | |
11 | * Unless required by applicable law or agreed to in writing, software | |
12 | * distributed under the License is distributed on an "AS IS" BASIS, | |
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 | * See the License for the specific language governing permissions and | |
15 | * limitations under the License. | |
16 | */ | |
17 | ||
18 | package org.apache.commons.codec; | |
19 | ||
20 | /** | |
21 | * Defines common encoding methods for String encoders. | |
22 | * | |
23 | * @version $Id$ | |
24 | */ | |
25 | public interface StringEncoder extends Encoder { | |
26 | ||
27 | /** | |
28 | * Encodes a String and returns a String. | |
29 | * | |
30 | * @param source | |
31 | * the String to encode | |
32 | * @return the encoded String | |
33 | * @throws EncoderException | |
34 | * thrown if there is an error condition during the encoding process. | |
35 | */ | |
36 | String encode(String source) throws EncoderException; | |
37 | } | |
38 |