< prev index next >

src/java.base/share/classes/java/time/format/package-info.java

Print this page


   1 /*
   2  * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  62 
  63 /**
  64  * <p>
  65  * Provides classes to print and parse dates and times.
  66  * </p>
  67  * <p>
  68  * Printing and parsing is based around the
  69  * {@link java.time.format.DateTimeFormatter DateTimeFormatter} class.
  70  * Instances are generally obtained from
  71  * {@link java.time.format.DateTimeFormatter DateTimeFormatter}, however
  72  * {@link java.time.format.DateTimeFormatterBuilder DateTimeFormatterBuilder}
  73  * can be used if more power is needed.
  74  * </p>
  75  * <p>
  76  * Localization occurs by calling
  77  * {@link java.time.format.DateTimeFormatter#withLocale(java.util.Locale) withLocale(Locale)}
  78  * on the formatter. Further customization is possible using
  79  * {@link java.time.format.DecimalStyle DecimalStyle}.
  80  * </p>
  81  *
  82  * <h3>Package specification</h3>
  83  * <p>
  84  * Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
  85  * in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
  86  * The Javadoc "@param" definition is used to summarise the null-behavior.
  87  * The "@throws {@link java.lang.NullPointerException}" is not explicitly documented in each method.
  88  * </p>
  89  * <p>
  90  * All calculations should check for numeric overflow and throw either an {@link java.lang.ArithmeticException}
  91  * or a {@link java.time.DateTimeException}.
  92  * </p>
  93  * @since 1.8
  94  */
  95 package java.time.format;
   1 /*
   2  * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  62 
  63 /**
  64  * <p>
  65  * Provides classes to print and parse dates and times.
  66  * </p>
  67  * <p>
  68  * Printing and parsing is based around the
  69  * {@link java.time.format.DateTimeFormatter DateTimeFormatter} class.
  70  * Instances are generally obtained from
  71  * {@link java.time.format.DateTimeFormatter DateTimeFormatter}, however
  72  * {@link java.time.format.DateTimeFormatterBuilder DateTimeFormatterBuilder}
  73  * can be used if more power is needed.
  74  * </p>
  75  * <p>
  76  * Localization occurs by calling
  77  * {@link java.time.format.DateTimeFormatter#withLocale(java.util.Locale) withLocale(Locale)}
  78  * on the formatter. Further customization is possible using
  79  * {@link java.time.format.DecimalStyle DecimalStyle}.
  80  * </p>
  81  *
  82  * <h2>Package specification</h2>
  83  * <p>
  84  * Unless otherwise noted, passing a null argument to a constructor or method in any class or interface
  85  * in this package will cause a {@link java.lang.NullPointerException NullPointerException} to be thrown.
  86  * The Javadoc "@param" definition is used to summarise the null-behavior.
  87  * The "@throws {@link java.lang.NullPointerException}" is not explicitly documented in each method.
  88  * </p>
  89  * <p>
  90  * All calculations should check for numeric overflow and throw either an {@link java.lang.ArithmeticException}
  91  * or a {@link java.time.DateTimeException}.
  92  * </p>
  93  * @since 1.8
  94  */
  95 package java.time.format;
< prev index next >