Skip to content
Permalink
Browse files
8261673: Move javadoc for the lookup mechanism to module-info
Reviewed-by: lancea, naoto, iris
  • Loading branch information
JoeWang-Java committed Mar 23, 2021
1 parent 7b6efd3 commit 289d48ae327a2f49699fc016b85d998a6a66db64
Show file tree
Hide file tree
Showing 9 changed files with 241 additions and 405 deletions.
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -139,53 +139,14 @@ public static DocumentBuilderFactory newDefaultInstance() {
}

/**
* Obtain a new instance of a
* {@code DocumentBuilderFactory}. This static method creates
* a new factory instance.
* This method uses the following ordered lookup procedure to determine
* the {@code DocumentBuilderFactory} implementation class to
* load:
* <ul>
* <li>
* Use the {@code javax.xml.parsers.DocumentBuilderFactory} system
* property.
* </li>
* <li>
* <p>
* Use the configuration file "jaxp.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
* <p>
* The jaxp.properties file is read only once by the JAXP implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in jaxp.properties after it has been read for the first time.
* </li>
* <li>
* <p>
* Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>
* Otherwise, the {@linkplain #newDefaultInstance() system-default}
* implementation is returned.
* </li>
* </ul>
* Obtains a new instance of a {@code DocumentBuilderFactory}.
* This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code DocumentBuilderFactory} implementation class to load.
*
* <p>
* Once an application has obtained a reference to a
* {@code DocumentBuilderFactory} it can use the factory to
* {@code DocumentBuilderFactory}, it can use the factory to
* configure and obtain parser instances.
*
*
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -145,52 +145,14 @@ public static SAXParserFactory newDefaultInstance() {
}

/**
* Obtain a new instance of a {@code SAXParserFactory}. This
* static method creates a new factory instance
* This method uses the following ordered lookup procedure to determine
* the {@code SAXParserFactory} implementation class to
* load:
* <ul>
* <li>
* Use the {@code javax.xml.parsers.SAXParserFactory} system
* property.
* </li>
* <li>
* <p>
* Use the configuration file "jaxp.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
* <p>
* The jaxp.properties file is read only once by the JAXP implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in jaxp.properties after it has been read for the first time.
* </li>
* <li>
* <p>
* Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>
* Otherwise, the {@linkplain #newDefaultInstance() system-default}
* implementation is returned.
* </li>
* </ul>
* Obtains a new instance of a {@code SAXParserFactory}.
* This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code SAXParserFactory} implementation class to load.
*
* <p>
* Once an application has obtained a reference to a
* {@code SAXParserFactory} it can use the factory to
* {@code SAXParserFactory}, it can use the factory to
* configure and obtain parser instances.
*
*
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -81,56 +81,12 @@ public static XMLEventFactory newInstance()
}

/**
* Create a new instance of the factory.
* <p>
* This static method creates a new factory instance.
* This method uses the following ordered lookup procedure to determine
* the XMLEventFactory implementation class to load:
* <ul>
* <li>
* Use the javax.xml.stream.XMLEventFactory system property.
* </li>
* <li>
* <p>
* Use the configuration file "stax.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
*
* <p>
* The stax.properties file is read only once by the implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in stax.properties after it has been read for the first time.
*
* <p>
* Use the jaxp configuration file "jaxp.properties". The file is in the same
* format as stax.properties and will only be read if stax.properties does
* not exist.
* </li>
* <li>
* <p>
* Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>
* Otherwise, the {@linkplain #newDefaultFactory() system-default}
* implementation is returned.
* </li>
* </ul>
* Creates a new instance of the factory. This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code XMLEventFactory} implementation class to load.
* <p>
* Once an application has obtained a reference to a XMLEventFactory it
* can use the factory to configure and obtain stream instances.
* Once an application has obtained a reference to a {@code XMLEventFactory}, it
* can use the factory to configure and obtain stream instances.
*
* @return an instance of the {@code XMLEventFactory}
* @throws FactoryConfigurationError in case of {@linkplain
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -167,53 +167,12 @@ public static XMLInputFactory newInstance()
}

/**
* Create a new instance of the factory.
* <p>
* This static method creates a new factory instance.
* This method uses the following ordered lookup procedure to determine
* the XMLInputFactory implementation class to load:
*
* <ul>
* <li>
* <p>Use the javax.xml.stream.XMLInputFactory system property.
* </li>
* <li>
* <p>Use the configuration file "stax.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
*
* <p>The stax.properties file is read only once by the implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in stax.properties after it has been read for the first time.
*
* <p>
* Use the jaxp configuration file "jaxp.properties". The file is in the same
* format as stax.properties and will only be read if stax.properties does
* not exist.
* </li>
* <li>
* <p>Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>Otherwise, the {@linkplain #newDefaultFactory() system-default}
* implementation is returned.
* </li>
* </ul>
* Creates a new instance of the factory. This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code XMLInputFactory} implementation class to load.
* <p>
* Once an application has obtained a reference to a XMLInputFactory it
* can use the factory to configure and obtain stream instances.
* Once an application has obtained a reference to a {@code XMLInputFactory}, it
* can use the factory to configure and obtain stream instances.
*
* @return an instance of the {@code XMLInputFactory}
* @throws FactoryConfigurationError in case of {@linkplain
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -144,55 +144,11 @@ public static XMLOutputFactory newInstance()
}

/**
* Create a new instance of the factory.
* <p>
* This static method creates a new factory instance. This method uses the
* following ordered lookup procedure to determine the XMLOutputFactory
* implementation class to load:
* <ul>
* <li>
* Use the javax.xml.stream.XMLOutputFactory system property.
* </li>
* <li>
* <p>
* Use the configuration file "stax.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
*
* <p>
* The stax.properties file is read only once by the implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in stax.properties after it has been read for the first time.
*
* <p>
* Use the jaxp configuration file "jaxp.properties". The file is in the same
* format as stax.properties and will only be read if stax.properties does
* not exist.
* </li>
* <li>
* <p>
* Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>
* Otherwise, the {@linkplain #newDefaultFactory() system-default}
* implementation is returned.
* </li>
* </ul>
* Creates a new instance of the factory. This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code XMLOutputFactory} implementation class to load.
* <p>
* Once an application has obtained a reference to a XMLOutputFactory it
* Once an application has obtained a reference to a {@code XMLOutputFactory}, it
* can use the factory to configure and obtain stream instances.
*
* @return an instance of the {@code XMLOutputFactory}
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -66,52 +66,12 @@ public static TransformerFactory newDefaultInstance() {
}

/**
* Obtain a new instance of a {@code TransformerFactory}.
* This static method creates a new factory instance.
* <p>
* This method uses the following ordered lookup procedure to determine
* the {@code TransformerFactory} implementation class to load:
* <ul>
* <li>
* Use the {@code javax.xml.transform.TransformerFactory} system
* property.
* </li>
* <li>
* <p>
* Use the configuration file "jaxp.properties". The file is in standard
* {@link java.util.Properties} format and typically located in the
* {@code conf} directory of the Java installation. It contains the fully qualified
* name of the implementation class with the key being the system property
* defined above.
* <p>
* The jaxp.properties file is read only once by the JAXP implementation
* and its values are then cached for future use. If the file does not exist
* when the first attempt is made to read from it, no further attempts are
* made to check for its existence. It is not possible to change the value
* of any property in jaxp.properties after it has been read for the first time.
* </li>
* <li>
* <p>
* Use the service-provider loading facility, defined by the
* {@link java.util.ServiceLoader} class, to attempt to locate and load an
* implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}:
* the service-provider loading facility will use the {@linkplain
* java.lang.Thread#getContextClassLoader() current thread's context class loader}
* to attempt to load the service. If the context class
* loader is null, the {@linkplain
* ClassLoader#getSystemClassLoader() system class loader} will be used.
* </li>
* <li>
* <p>
* Otherwise, the {@linkplain #newDefaultInstance() system-default}
* implementation is returned.
* </li>
* </ul>
*
* Obtains a new instance of a {@code TransformerFactory}. This method uses the
* <a href="../../../module-summary.html#LookupMechanism">JAXP Lookup Mechanism</a>
* to determine the {@code TransformerFactory} implementation class to load.
* <p>
* Once an application has obtained a reference to a
* {@code TransformerFactory} it can use the factory to configure
* {@code TransformerFactory}, it can use the factory to configure
* and obtain transformer instances.
*
* @return new TransformerFactory instance, never null.

0 comments on commit 289d48a

Please sign in to comment.