001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package org.apache.commons.math3.geometry.euclidean.twod; 019 020import java.text.FieldPosition; 021import java.text.NumberFormat; 022import java.text.ParsePosition; 023import java.util.Locale; 024 025import org.apache.commons.math3.exception.MathParseException; 026import org.apache.commons.math3.geometry.Vector; 027import org.apache.commons.math3.geometry.VectorFormat; 028import org.apache.commons.math3.util.CompositeFormat; 029 030/** 031 * Formats a 2D vector in components list format "{x; y}". 032 * <p>The prefix and suffix "{" and "}" and the separator "; " can be replaced by 033 * any user-defined strings. The number format for components can be configured.</p> 034 * <p>White space is ignored at parse time, even if it is in the prefix, suffix 035 * or separator specifications. So even if the default separator does include a space 036 * character that is used at format time, both input string "{1;1}" and 037 * " { 1 ; 1 } " will be parsed without error and the same vector will be 038 * returned. In the second case, however, the parse position after parsing will be 039 * just after the closing curly brace, i.e. just before the trailing space.</p> 040 * <p><b>Note:</b> using "," as a separator may interfere with the grouping separator 041 * of the default {@link NumberFormat} for the current locale. Thus it is advised 042 * to use a {@link NumberFormat} instance with disabled grouping in such a case.</p> 043 * 044 * @since 3.0 045 */ 046public class Vector2DFormat extends VectorFormat<Euclidean2D> { 047 048 /** 049 * Create an instance with default settings. 050 * <p>The instance uses the default prefix, suffix and separator: 051 * "{", "}", and "; " and the default number format for components.</p> 052 */ 053 public Vector2DFormat() { 054 super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR, 055 CompositeFormat.getDefaultNumberFormat()); 056 } 057 058 /** 059 * Create an instance with a custom number format for components. 060 * @param format the custom format for components. 061 */ 062 public Vector2DFormat(final NumberFormat format) { 063 super(DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_SEPARATOR, format); 064 } 065 066 /** 067 * Create an instance with custom prefix, suffix and separator. 068 * @param prefix prefix to use instead of the default "{" 069 * @param suffix suffix to use instead of the default "}" 070 * @param separator separator to use instead of the default "; " 071 */ 072 public Vector2DFormat(final String prefix, final String suffix, 073 final String separator) { 074 super(prefix, suffix, separator, CompositeFormat.getDefaultNumberFormat()); 075 } 076 077 /** 078 * Create an instance with custom prefix, suffix, separator and format 079 * for components. 080 * @param prefix prefix to use instead of the default "{" 081 * @param suffix suffix to use instead of the default "}" 082 * @param separator separator to use instead of the default "; " 083 * @param format the custom format for components. 084 */ 085 public Vector2DFormat(final String prefix, final String suffix, 086 final String separator, final NumberFormat format) { 087 super(prefix, suffix, separator, format); 088 } 089 090 /** 091 * Returns the default 2D vector format for the current locale. 092 * @return the default 2D vector format. 093 */ 094 public static Vector2DFormat getInstance() { 095 return getInstance(Locale.getDefault()); 096 } 097 098 /** 099 * Returns the default 2D vector format for the given locale. 100 * @param locale the specific locale used by the format. 101 * @return the 2D vector format specific to the given locale. 102 */ 103 public static Vector2DFormat getInstance(final Locale locale) { 104 return new Vector2DFormat(CompositeFormat.getDefaultNumberFormat(locale)); 105 } 106 107 /** {@inheritDoc} */ 108 @Override 109 public StringBuffer format(final Vector<Euclidean2D> vector, final StringBuffer toAppendTo, 110 final FieldPosition pos) { 111 final Vector2D p2 = (Vector2D) vector; 112 return format(toAppendTo, pos, p2.getX(), p2.getY()); 113 } 114 115 /** {@inheritDoc} */ 116 @Override 117 public Vector2D parse(final String source) throws MathParseException { 118 ParsePosition parsePosition = new ParsePosition(0); 119 Vector2D result = parse(source, parsePosition); 120 if (parsePosition.getIndex() == 0) { 121 throw new MathParseException(source, 122 parsePosition.getErrorIndex(), 123 Vector2D.class); 124 } 125 return result; 126 } 127 128 /** {@inheritDoc} */ 129 @Override 130 public Vector2D parse(final String source, final ParsePosition pos) { 131 final double[] coordinates = parseCoordinates(2, source, pos); 132 if (coordinates == null) { 133 return null; 134 } 135 return new Vector2D(coordinates[0], coordinates[1]); 136 } 137 138}