jdk/src/java.base/share/classes/java/net/URLStreamHandlerFactory.java
author chegar
Mon, 23 Feb 2015 15:48:20 +0000
changeset 29097 01a70c01f5a1
parent 25859 3317bb8137f4
child 32982 a54c0a721890
permissions -rw-r--r--
8064924: Update java.net.URL to work with modules Reviewed-by: alanb, plevart, psandoz
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
19069
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
     2
 * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.net;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
19069
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    29
 * This interface defines a factory for {@code URL} stream
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * protocol handlers.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * <p>
19069
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    32
 * It is used by the {@code URL} class to create a
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    33
 * {@code URLStreamHandler} for a specific protocol.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * @author  Arthur van Hoff
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * @see     java.net.URL
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * @see     java.net.URLStreamHandler
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 19069
diff changeset
    38
 * @since   1.0
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
public interface URLStreamHandlerFactory {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
    /**
19069
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    42
     * Creates a new {@code URLStreamHandler} instance with the specified
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     * protocol.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     *
19069
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    45
     * @param   protocol   the protocol ("{@code ftp}",
1d9cb0d080e3 8021833: javadoc cleanup in java.net
juh
parents: 5506
diff changeset
    46
     *                     "{@code http}", "{@code nntp}", etc.).
29097
01a70c01f5a1 8064924: Update java.net.URL to work with modules
chegar
parents: 25859
diff changeset
    47
     * @return  a {@code URLStreamHandler} for the specific protocol, or {@code
01a70c01f5a1 8064924: Update java.net.URL to work with modules
chegar
parents: 25859
diff changeset
    48
     *          null} if this factory cannot create a handler for the specific
01a70c01f5a1 8064924: Update java.net.URL to work with modules
chegar
parents: 25859
diff changeset
    49
     *          protocol
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * @see     java.net.URLStreamHandler
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    URLStreamHandler createURLStreamHandler(String protocol);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
}