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    *      https://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  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  
23  package org.hipparchus.geometry.euclidean.oned;
24  
25  import java.text.FieldPosition;
26  import java.text.NumberFormat;
27  import java.text.ParsePosition;
28  import java.util.Locale;
29  
30  import org.hipparchus.exception.LocalizedCoreFormats;
31  import org.hipparchus.exception.MathIllegalStateException;
32  import org.hipparchus.geometry.Vector;
33  import org.hipparchus.geometry.VectorFormat;
34  import org.hipparchus.util.CompositeFormat;
35  
36  /**
37   * Formats a 1D vector in components list format "{x}".
38   * <p>The prefix and suffix "{" and "}" can be replaced by
39   * any user-defined strings. The number format for components can be configured.</p>
40   * <p>White space is ignored at parse time, even if it is in the prefix, suffix
41   * or separator specifications. So even if the default separator does include a space
42   * character that is used at format time, both input string "{1}" and
43   * " { 1 } " will be parsed without error and the same vector will be
44   * returned. In the second case, however, the parse position after parsing will be
45   * just after the closing curly brace, i.e. just before the trailing space.</p>
46   * <p><b>Note:</b> using "," as a separator may interfere with the grouping separator
47   * of the default {@link NumberFormat} for the current locale. Thus it is advised
48   * to use a {@link NumberFormat} instance with disabled grouping in such a case.</p>
49   *
50   */
51  public class Vector1DFormat extends VectorFormat<Euclidean1D, Vector1D> {
52  
53      /**
54       * Create an instance with default settings.
55       * <p>The instance uses the default prefix, suffix and separator:
56       * "{", "}", and "; " and the default number format for components.</p>
57       */
58      public Vector1DFormat() {
59          super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR,
60                CompositeFormat.getDefaultNumberFormat());
61      }
62  
63      /**
64       * Create an instance with a custom number format for components.
65       * @param format the custom format for components.
66       */
67      public Vector1DFormat(final NumberFormat format) {
68          super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR, format);
69      }
70  
71      /**
72       * Create an instance with custom prefix, suffix and separator.
73       * @param prefix prefix to use instead of the default "{"
74       * @param suffix suffix to use instead of the default "}"
75       */
76      public Vector1DFormat(final String prefix, final String suffix) {
77          super(prefix, suffix, DEFAULT_SEPARATOR, CompositeFormat.getDefaultNumberFormat());
78      }
79  
80      /**
81       * Create an instance with custom prefix, suffix, separator and format
82       * for components.
83       * @param prefix prefix to use instead of the default "{"
84       * @param suffix suffix to use instead of the default "}"
85       * @param format the custom format for components.
86       */
87      public Vector1DFormat(final String prefix, final String suffix,
88                           final NumberFormat format) {
89          super(prefix, suffix, DEFAULT_SEPARATOR, format);
90      }
91  
92      /**
93       * Returns the default 1D vector format for the current locale.
94       * @return the default 1D vector format.
95       * @since 1.4
96       */
97      public static Vector1DFormat getVector1DFormat() {
98          return getVector1DFormat(Locale.getDefault());
99      }
100 
101     /**
102      * Returns the default 1D vector format for the given locale.
103      * @param locale the specific locale used by the format.
104      * @return the 1D vector format specific to the given locale.
105      * @since 1.4
106      */
107     public static Vector1DFormat getVector1DFormat(final Locale locale) {
108         return new Vector1DFormat(CompositeFormat.getDefaultNumberFormat(locale));
109     }
110 
111     /** {@inheritDoc} */
112     @Override
113     public StringBuffer format(final Vector<Euclidean1D, Vector1D> vector, final StringBuffer toAppendTo,
114                                final FieldPosition pos) {
115         final Vector1D p1 = (Vector1D) vector;
116         return format(toAppendTo, pos, p1.getX());
117     }
118 
119     /** {@inheritDoc} */
120     @Override
121     public Vector1D parse(final String source) throws MathIllegalStateException {
122         ParsePosition parsePosition = new ParsePosition(0);
123         Vector1D result = parse(source, parsePosition);
124         if (parsePosition.getIndex() == 0) {
125             throw new MathIllegalStateException(LocalizedCoreFormats.CANNOT_PARSE_AS_TYPE,
126                                                 source, parsePosition.getErrorIndex(),
127                                                 Vector1D.class);
128         }
129         return result;
130     }
131 
132     /** {@inheritDoc} */
133     @Override
134     public Vector1D parse(final String source, final ParsePosition pos) {
135         final double[] coordinates = parseCoordinates(1, source, pos);
136         if (coordinates == null) {
137             return null;
138         }
139         return new Vector1D(coordinates[0]);
140     }
141 
142 }