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    
018    package org.apache.commons.beanutils.locale.converters;
019    
020    import java.util.Locale;
021    import java.text.ParseException;
022    
023    
024    /**
025     * <p>Standard {@link org.apache.commons.beanutils.locale.LocaleConverter} 
026     * implementation that converts an incoming
027     * locale-sensitive String into a <code>java.lang.Long</code> object,
028     * optionally using a default value or throwing a 
029     * {@link org.apache.commons.beanutils.ConversionException}
030     * if a conversion error occurs.</p>
031     *
032     * @author Yauheny Mikulski
033     */
034    
035    public class LongLocaleConverter extends DecimalLocaleConverter {
036    
037    
038        // ----------------------------------------------------------- Constructors
039    
040        /**
041         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
042         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
043         * if a conversion error occurs. The locale is the default locale for
044         * this instance of the Java Virtual Machine and an unlocalized pattern is used
045         * for the convertion.
046         *
047         */
048        public LongLocaleConverter() {
049    
050            this(false);
051        }
052    
053        /**
054         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
055         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
056         * if a conversion error occurs. The locale is the default locale for
057         * this instance of the Java Virtual Machine.
058         *
059         * @param locPattern    Indicate whether the pattern is localized or not
060         */
061        public LongLocaleConverter(boolean locPattern) {
062    
063            this(Locale.getDefault(), locPattern);
064        }
065    
066        /**
067         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
068         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
069         * if a conversion error occurs. An unlocalized pattern is used for the convertion.
070         *
071         * @param locale        The locale
072         */
073        public LongLocaleConverter(Locale locale) {
074    
075            this(locale, false);
076        }
077    
078        /**
079         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
080         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
081         * if a conversion error occurs.
082         *
083         * @param locale        The locale
084         * @param locPattern    Indicate whether the pattern is localized or not
085         */
086        public LongLocaleConverter(Locale locale, boolean locPattern) {
087    
088            this(locale, (String) null, locPattern);
089        }
090    
091        /**
092         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
093         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
094         * if a conversion error occurs. An unlocalized pattern is used for the convertion.
095         *
096         * @param locale        The locale
097         * @param pattern       The convertion pattern
098         */
099        public LongLocaleConverter(Locale locale, String pattern) {
100    
101            this(locale, pattern, false);
102        }
103    
104        /**
105         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
106         * that will throw a {@link org.apache.commons.beanutils.ConversionException}
107         * if a conversion error occurs.
108         *
109         * @param locale        The locale
110         * @param pattern       The convertion pattern
111         * @param locPattern    Indicate whether the pattern is localized or not
112         */
113        public LongLocaleConverter(Locale locale, String pattern, boolean locPattern) {
114    
115            super(locale, pattern, locPattern);
116        }
117    
118        /**
119         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
120         * that will return the specified default value
121         * if a conversion error occurs. The locale is the default locale for
122         * this instance of the Java Virtual Machine and an unlocalized pattern is used
123         * for the convertion.
124         *
125         * @param defaultValue  The default value to be returned
126         */
127        public LongLocaleConverter(Object defaultValue) {
128    
129            this(defaultValue, false);
130        }
131    
132        /**
133         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
134         * that will return the specified default value
135         * if a conversion error occurs. The locale is the default locale for
136         * this instance of the Java Virtual Machine.
137         *
138         * @param defaultValue  The default value to be returned
139         * @param locPattern    Indicate whether the pattern is localized or not
140         */
141        public LongLocaleConverter(Object defaultValue, boolean locPattern) {
142    
143            this(defaultValue, Locale.getDefault(), locPattern);
144        }
145    
146        /**
147         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
148         * that will return the specified default value
149         * if a conversion error occurs. An unlocalized pattern is used for the convertion.
150         *
151         * @param defaultValue  The default value to be returned
152         * @param locale        The locale
153         */
154        public LongLocaleConverter(Object defaultValue, Locale locale) {
155    
156            this(defaultValue, locale, false);
157        }
158    
159        /**
160         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
161         * that will return the specified default value
162         * if a conversion error occurs.
163         *
164         * @param defaultValue  The default value to be returned
165         * @param locale        The locale
166         * @param locPattern    Indicate whether the pattern is localized or not
167         */
168        public LongLocaleConverter(Object defaultValue, Locale locale, boolean locPattern) {
169    
170            this(defaultValue, locale, null, locPattern);
171        }
172    
173        /**
174         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
175         * that will return the specified default value
176         * if a conversion error occurs. An unlocalized pattern is used for the convertion.
177         *
178         * @param defaultValue  The default value to be returned
179         * @param locale        The locale
180         * @param pattern       The convertion pattern
181         */
182        public LongLocaleConverter(Object defaultValue, Locale locale, String pattern) {
183    
184            this(defaultValue, locale, pattern, false);
185        }
186    
187        /**
188         * Create a {@link org.apache.commons.beanutils.locale.LocaleConverter} 
189         * that will return the specified default value
190         * if a conversion error occurs.
191         *
192         * @param defaultValue  The default value to be returned
193         * @param locale        The locale
194         * @param pattern       The convertion pattern
195         * @param locPattern    Indicate whether the pattern is localized or not
196         */
197        public LongLocaleConverter(Object defaultValue, Locale locale, String pattern, boolean locPattern) {
198    
199            super(defaultValue, locale, pattern, locPattern);
200        }
201    
202        /**
203         * Convert the specified locale-sensitive input object into an output object of the
204         * specified type. This method will return a Long type.
205         *
206         * @param value The input object to be converted
207         * @param pattern The pattern is used for the convertion
208         * @return The converted value
209         *
210         * @exception org.apache.commons.beanutils.ConversionException if conversion
211         * cannot be performed successfully
212         * @throws ParseException if an error occurs parsing a String to a Number
213         * @since 1.8.0
214         */
215        protected Object parse(Object value, String pattern) throws ParseException {
216    
217            Object result = super.parse(value, pattern);
218    
219            if (result == null || result instanceof Long) {
220                return result;
221            }
222    
223            return new Long(((Number)result).longValue());
224    
225        }
226    }