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.beanutils.converters;
18  
19  /**
20   * {@link NumberConverter} implementation that handles conversion to
21   * and from <b>java.lang.Long</b> objects.
22   * <p>
23   * This implementation can be configured to handle conversion either
24   * by using Long's default String conversion, or by using a Locale's pattern
25   * or by specifying a format pattern. See the {@link NumberConverter}
26   * documentation for further details.
27   * <p>
28   * Can be configured to either return a <i>default value</i> or throw a
29   * <code>ConversionException</code> if a conversion error occurs.
30   *
31   * @version $Id$
32   * @since 1.3
33   */
34  public final class LongConverter extends NumberConverter {
35  
36      /**
37       * Construct a <b>java.lang.Long</b> <i>Converter</i> that throws
38       * a <code>ConversionException</code> if an error occurs.
39       */
40      public LongConverter() {
41          super(false);
42      }
43  
44      /**
45       * Construct a <b>java.lang.Long</b> <i>Converter</i> that returns
46       * a default value if an error occurs.
47       *
48       * @param defaultValue The default value to be returned
49       * if the value to be converted is missing or an error
50       * occurs converting the value.
51       */
52      public LongConverter(final Object defaultValue) {
53          super(false, defaultValue);
54      }
55  
56      /**
57       * Return the default type this <code>Converter</code> handles.
58       *
59       * @return The default type this <code>Converter</code> handles.
60       * @since 1.8.0
61       */
62      @Override
63      protected Class<Long> getDefaultType() {
64          return Long.class;
65      }
66  
67  }