001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019
020package org.apache.commons.compress.archivers.zip;
021
022import java.nio.charset.Charset;
023
024/**
025 * An interface added to allow access to the character set associated with an {@link NioZipEncoding}, without requiring a new method to be added to
026 * {@link ZipEncoding}.
027 * <p>
028 * This avoids introducing a potentially breaking change, or making {@link NioZipEncoding} a public class.
029 * </p>
030 *
031 * @since 1.15
032 */
033public interface CharsetAccessor {
034
035    /**
036     * Provides access to the character set associated with an object.
037     * <p>
038     * This allowsNIOoriented code to use more natural character encoding/decoding methods, whilst allowing existing code to continue to rely on special-case
039     * error handling for UTF-8.
040     * </p>
041     *
042     * @return the character set associated with this object
043     */
044    Charset getCharset();
045}