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.any23.encoding; 19 20 import java.io.IOException; 21 import java.io.InputStream; 22 23 /** 24 * Defines a detector for <i>charset encoding</i>. 25 * 26 * @author Michele Mostarda ( michele.mostarda@gmail.com ) 27 */ 28 public interface EncodingDetector { 29 30 /** 31 * Guesses the data encoding. 32 * 33 * @param input 34 * the input stream containing the data. 35 * 36 * @return a string compliant to <a href="http://www.iana.org/assignments/character-sets">IANA Charset 37 * Specification</a>. 38 * 39 * @throws IOException 40 * if there is an error whilst guessing the encoding. 41 */ 42 String guessEncoding(InputStream input) throws IOException; 43 44 /** 45 * Guesses the data encoding. 46 * 47 * @param input 48 * the input stream containing the data. 49 * @param contentType 50 * the declared content type of the data. 51 * 52 * @return a string compliant to <a href="http://www.iana.org/assignments/character-sets">IANA Charset 53 * Specification</a>. 54 * 55 * @throws IOException 56 * if there is an error whilst guessing the encoding. 57 */ 58 default String guessEncoding(InputStream input, String contentType) throws IOException { 59 return guessEncoding(input); 60 } 61 62 }