1 /*
   2  * Copyright (c) 2000, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /**
  25  * <code>BackEnd</code> is an abstract base class for a back-end of compiling
  26  * Olson's zoneinfo database and generating Java zoneinfo database.
  27  *
  28  * @since 1.4
  29  */
  30 abstract class BackEnd {
  31 
  32     /**
  33      * Receives each zone's TimeZone information which was created by
  34      * {@link Zoneinfo#parse} in class <code>Zoneinfo</code>,
  35      * and processes it.
  36      *
  37      * @param tz Timezone object for each zone
  38      * @return 0 if no error occurred, otherwise 1.
  39      */
  40     abstract int processZoneinfo(Timezone tz);
  41 
  42     /**
  43      * Receives whole information which is generated by JavaZic's front-end
  44      * in the form of Mapping object and generates all Java zone information
  45      * files.
  46      *
  47      * @param m Mappings object which is generated by
  48      *          {@link Main#compile() Main.compile()}.
  49      * @return 0 if no error occurred, otherwise 1.
  50      */
  51     abstract int generateSrc(Mappings m);
  52 
  53     /**
  54      * Decides which backend class should be used and returns its instance.
  55      * @return an instance of backend class
  56      */
  57     static BackEnd getBackEnd() {
  58         if (Zoneinfo.isYearForTimeZoneDataSpecified) {
  59             return new Simple();
  60         } else if (Main.outputDoc) {
  61             return new GenDoc();
  62         } else {
  63             return new Gen();
  64         }
  65     }
  66 }