1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.commons.compress.archivers.zip;
21
22 import java.nio.charset.Charset;
23
24 /**
25 * An interface added to allow access to the character set associated with an {@link NioZipEncoding}, without requiring a new method to be added to
26 * {@link ZipEncoding}.
27 * <p>
28 * This avoids introducing a potentially breaking change, or making {@link NioZipEncoding} a public class.
29 * </p>
30 *
31 * @since 1.15
32 */
33 public interface CharsetAccessor {
34
35 /**
36 * Provides access to the character set associated with an object.
37 * <p>
38 * This allowsNIOoriented code to use more natural character encoding/decoding methods, whilst allowing existing code to continue to rely on special-case
39 * error handling for UTF-8.
40 * </p>
41 *
42 * @return the character set associated with this object
43 */
44 Charset getCharset();
45 }