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  package org.apache.commons.geometry.io.core;
    18
    19  import java.nio.charset.Charset;
    20
    21  /** Interface containing basic metadata fields for use in I/O operations.
    22   */
    23  public interface GeometryIOMetadata {
    24
    25      /** Get the file name associated with the operation, if any.
    26       * @return file name associated with the operation or null
    27       *      if unknown or not applicable
    28       */
    29      String getFileName();
    30
    31      /** Get the charset for the operation, if any.
    32       * @return charset for the operation or null if unknown or
    33       *      not applicable
    34       */
    35      Charset getCharset();
    36  }