View Javadoc

    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.mime;
    19
    20  import java.io.InputStream;
    21
    22  /**
    23   * This detector is able to estimate the <code>MIME</code> type of some given raw data.
    24   */
    25  public interface MIMETypeDetector {
    26
    27      /**
    28       * Estimates the <code>MIME</code> type of the content of input file.
    29       *
    30       * @param fileName
    31       *            name of the file.
    32       * @param input
    33       *            content of the file.
    34       * @param mimeTypeFromMetadata
    35       *            mimetype declared in metadata.
    36       *
    37       * @return the supposed mime type or <code>null</code> if nothing appropriate found.
    38       */
    39      public MIMEType guessMIMEType(String fileName, InputStream input, MIMEType mimeTypeFromMetadata);
    40
    41  }