jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocFileFactory.java@fcf89720ae71

8003967: detect and remove all mutable implicit static enum fields in langtools
Reviewed-by: jjg

     1 /*

     2  * Copyright (c) 1998, 2012, 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

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit.util;

    28 import java.util.Map;

    29 import java.util.WeakHashMap;

    31 import javax.tools.JavaFileManager;

    32 import javax.tools.JavaFileManager.Location;

    33 import javax.tools.StandardJavaFileManager;

    34 import javax.tools.StandardLocation;

    36 import com.sun.tools.doclets.internal.toolkit.Configuration;

    38 /**

    39  * Factory for DocFile objects.

    40  *

    41  *  <p><b>This is NOT part of any supported API.

    42  *  If you write code that depends on this, you do so at your own risk.

    43  *  This code and its internal interfaces are subject to change or

    44  *  deletion without notice.</b>

    45  *

    46  * @since 1.8

    47  */

    48 abstract class DocFileFactory {

    49     private static final Map<Configuration, DocFileFactory> factories =

    50             new WeakHashMap<Configuration, DocFileFactory>();

    52     /**

    53      * Get the appropriate factory, based on the file manager given in the

    54      * configuration.

    55      */

    56     static synchronized DocFileFactory getFactory(Configuration configuration) {

    57         DocFileFactory f = factories.get(configuration);

    58         if (f == null) {

    59             JavaFileManager fm = configuration.getFileManager();

    60             if (fm instanceof StandardJavaFileManager)

    61                 f = new StandardDocFileFactory(configuration);

    62             else {

    63                 try {

    64                     Class<?> pathFileManagerClass =

    65                             Class.forName("com.sun.tools.javac.nio.PathFileManager");

    66                     if (pathFileManagerClass.isAssignableFrom(fm.getClass()))

    67                         f = new PathDocFileFactory(configuration);

    68                 } catch (Throwable t) {

    69                     throw new IllegalStateException(t);

    70                 }

    71             }

    72             factories.put(configuration, f);

    73         }

    74         return f;

    75     }

    77     protected Configuration configuration;

    79     protected DocFileFactory(Configuration configuration) {

    80         this.configuration = configuration;

    81     }

    83     /** Create a DocFile for a directory. */

    84     abstract DocFile createFileForDirectory(String file);

    86     /** Create a DocFile for a file that will be opened for reading. */

    87     abstract DocFile createFileForInput(String file);

    89     /** Create a DocFile for a file that will be opened for writing. */

    90     abstract DocFile createFileForOutput(DocPath path);

    92     /**

    93      * List the directories and files found in subdirectories along the

    94      * elements of the given location.

    95      * @param location currently, only {@link StandardLocation#SOURCE_PATH} is supported.

    96      * @param path the subdirectory of the directories of the location for which to

    97      *  list files

    98      */

    99     abstract Iterable<DocFile> list(Location location, DocPath path);

   100 }

Mercurial > jdk8-mips64-public > langtools / file revision