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  /** Abstract base class for {@link GeometryIOMetadata} implementations.
22   */
23  public class AbstractGeometryIOMetadata implements GeometryIOMetadata {
24  
25      /** File name; may be null. */
26      private final String fileName;
27  
28      /** Charset; may be null. */
29      private final Charset charset;
30  
31      /** Construct a new instance with the given file name and charset.
32       * @param fileName file name; may be null
33       * @param charset charset; may be null
34       */
35      protected AbstractGeometryIOMetadata(final String fileName, final Charset charset) {
36          this.fileName = fileName;
37          this.charset = charset;
38      }
39  
40      /** {@inheritDoc} */
41      @Override
42      public String getFileName() {
43          return fileName;
44      }
45  
46      /** {@inheritDoc} */
47      @Override
48      public Charset getCharset() {
49          return charset;
50      }
51  
52      /** {@inheritDoc} */
53      @Override
54      public String toString() {
55          final StringBuilder sb = new StringBuilder();
56          sb.append(getClass().getSimpleName())
57              .append("[fileName= ")
58              .append(getFileName())
59              .append(']');
60  
61          return sb.toString();
62      }
63  }