src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DocFileFactory.java

Thu, 31 Aug 2017 15:17:03 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:17:03 +0800
changeset 2525
2eb010b6cb22
parent 1442
fcf89720ae71
parent 0
959103a6100f
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.doclets.internal.toolkit.util;
aoqi@0 27
aoqi@0 28 import java.util.Map;
aoqi@0 29 import java.util.WeakHashMap;
aoqi@0 30
aoqi@0 31 import javax.tools.JavaFileManager;
aoqi@0 32 import javax.tools.JavaFileManager.Location;
aoqi@0 33 import javax.tools.StandardJavaFileManager;
aoqi@0 34 import javax.tools.StandardLocation;
aoqi@0 35
aoqi@0 36 import com.sun.tools.doclets.internal.toolkit.Configuration;
aoqi@0 37
aoqi@0 38 /**
aoqi@0 39 * Factory for DocFile objects.
aoqi@0 40 *
aoqi@0 41 * <p><b>This is NOT part of any supported API.
aoqi@0 42 * If you write code that depends on this, you do so at your own risk.
aoqi@0 43 * This code and its internal interfaces are subject to change or
aoqi@0 44 * deletion without notice.</b>
aoqi@0 45 *
aoqi@0 46 * @since 1.8
aoqi@0 47 */
aoqi@0 48 abstract class DocFileFactory {
aoqi@0 49 private static final Map<Configuration, DocFileFactory> factories =
aoqi@0 50 new WeakHashMap<Configuration, DocFileFactory>();
aoqi@0 51
aoqi@0 52 /**
aoqi@0 53 * Get the appropriate factory, based on the file manager given in the
aoqi@0 54 * configuration.
aoqi@0 55 */
aoqi@0 56 static synchronized DocFileFactory getFactory(Configuration configuration) {
aoqi@0 57 DocFileFactory f = factories.get(configuration);
aoqi@0 58 if (f == null) {
aoqi@0 59 JavaFileManager fm = configuration.getFileManager();
aoqi@0 60 if (fm instanceof StandardJavaFileManager)
aoqi@0 61 f = new StandardDocFileFactory(configuration);
aoqi@0 62 else {
aoqi@0 63 try {
aoqi@0 64 Class<?> pathFileManagerClass =
aoqi@0 65 Class.forName("com.sun.tools.javac.nio.PathFileManager");
aoqi@0 66 if (pathFileManagerClass.isAssignableFrom(fm.getClass()))
aoqi@0 67 f = new PathDocFileFactory(configuration);
aoqi@0 68 } catch (Throwable t) {
aoqi@0 69 throw new IllegalStateException(t);
aoqi@0 70 }
aoqi@0 71 }
aoqi@0 72 factories.put(configuration, f);
aoqi@0 73 }
aoqi@0 74 return f;
aoqi@0 75 }
aoqi@0 76
aoqi@0 77 protected Configuration configuration;
aoqi@0 78
aoqi@0 79 protected DocFileFactory(Configuration configuration) {
aoqi@0 80 this.configuration = configuration;
aoqi@0 81 }
aoqi@0 82
aoqi@0 83 /** Create a DocFile for a directory. */
aoqi@0 84 abstract DocFile createFileForDirectory(String file);
aoqi@0 85
aoqi@0 86 /** Create a DocFile for a file that will be opened for reading. */
aoqi@0 87 abstract DocFile createFileForInput(String file);
aoqi@0 88
aoqi@0 89 /** Create a DocFile for a file that will be opened for writing. */
aoqi@0 90 abstract DocFile createFileForOutput(DocPath path);
aoqi@0 91
aoqi@0 92 /**
aoqi@0 93 * List the directories and files found in subdirectories along the
aoqi@0 94 * elements of the given location.
aoqi@0 95 * @param location currently, only {@link StandardLocation#SOURCE_PATH} is supported.
aoqi@0 96 * @param path the subdirectory of the directories of the location for which to
aoqi@0 97 * list files
aoqi@0 98 */
aoqi@0 99 abstract Iterable<DocFile> list(Location location, DocPath path);
aoqi@0 100 }

mercurial