Google Git
Sign in
apache / hadoop / refs/heads/YARN-5734 / . / hadoop-common-project / hadoop-common / dev-support / jdiff / Apache_Hadoop_Common_2.7.2.xml
blob: 47e64d8cc6a14acc1eeba7862c2156fe4e62945e [file] [log] [blame]
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
<!-- Generated by the JDiff Javadoc doclet -->
<!-- (http://www.jdiff.org) -->
<!-- on Wed Aug 24 13:50:51 PDT 2016 -->
<api
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:noNamespaceSchemaLocation='api.xsd'
name="Apache Hadoop Common 2.7.2"
jdversion="1.0.9">
<!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/jdiff.jar -verbose -classpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/classes:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-2.7.2.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home/lib/tools.jar:/Users/vinodkv/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/vinodkv/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/vinodkv/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/vinodkv/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/vinodkv/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/vinodkv/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/vinodkv/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/vinodkv/.m2/repository/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/Users/vinodkv/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/vinodkv/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/vinodkv/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/vinodkv/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/vinodkv/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/vinodkv/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/vinodkv/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/vinodkv/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/vinodkv/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/vinodkv/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/vinodkv/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/vinodkv/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/vinodkv/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/vinodkv/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/vinodkv/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/vinodkv/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/vinodkv/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/vinodkv/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/vinodkv/.m2/repository/org/slf4j/slf4j-api/1.7.10/slf4j-api-1.7.10.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/vinodkv/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/vinodkv/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/vinodkv/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/vinodkv/.m2/repository/org/apache/ant/ant/1.8.1/ant-1.8.1.jar:/Users/vinodkv/.m2/repository/org/apache/ant/ant-launcher/1.8.1/ant-launcher-1.8.1.jar:/Users/vinodkv/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/Users/vinodkv/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-auth/target/hadoop-auth-2.7.2.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-framework/2.7.1/curator-framework-2.7.1.jar:/Users/vinodkv/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-client/2.7.1/curator-client-2.7.1.jar:/Users/vinodkv/.m2/repository/org/apache/curator/curator-recipes/2.7.1/curator-recipes-2.7.1.jar:/Users/vinodkv/.m2/repository/com/google/code/findbugs/jsr305/3.0.0/jsr305-3.0.0.jar:/Users/vinodkv/.m2/repository/org/apache/htrace/htrace-core/3.1.0-incubating/htrace-core-3.1.0-incubating.jar:/Users/vinodkv/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/vinodkv/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/vinodkv/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/vinodkv/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar -sourcepath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/hadoop-annotations.jar:/Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/jdiff.jar -apidir /Users/vinodkv/Workspace/eclipse-workspace/apache-git/hadoop/hadoop-common-project/hadoop-common/target/site/jdiff/xml -apiname Apache Hadoop Common 2.7.2 -->
<package name="org.apache.hadoop">
<!-- start class org.apache.hadoop.HadoopIllegalArgumentException -->
<class name="HadoopIllegalArgumentException" extends="java.lang.IllegalArgumentException"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="HadoopIllegalArgumentException" type="java.lang.String"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructs exception with the specified detail message.
@param message detailed message.]]>
</doc>
</constructor>
<doc>
<![CDATA[Indicates that a method has been passed illegal or invalid argument. This
exception is thrown instead of IllegalArgumentException to differentiate the
exception thrown in Hadoop implementation from the one thrown in JDK.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.HadoopIllegalArgumentException -->
</package>
<package name="org.apache.hadoop.conf">
<!-- start interface org.apache.hadoop.conf.Configurable -->
<interface name="Configurable" abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<method name="setConf"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Set the configuration to be used by this object.]]>
</doc>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the configuration used by this object.]]>
</doc>
</method>
<doc>
<![CDATA[Something that may be configured with a {@link Configuration}.]]>
</doc>
</interface>
<!-- end interface org.apache.hadoop.conf.Configurable -->
<!-- start class org.apache.hadoop.conf.Configuration -->
<class name="Configuration" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="java.lang.Iterable"/>
<implements name="org.apache.hadoop.io.Writable"/>
<constructor name="Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration.]]>
</doc>
</constructor>
<constructor name="Configuration" type="boolean"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration where the behavior of reading from the default
resources can be turned off.
If the parameter {@code loadDefaults} is false, the new instance
will not load resources from the default files.
@param loadDefaults specifies whether to load from the default files]]>
</doc>
</constructor>
<constructor name="Configuration" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[A new configuration with the same settings cloned from another.
@param other the configuration from which to clone settings.]]>
</doc>
</constructor>
<method name="addDeprecations"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="deltas" type="org.apache.hadoop.conf.Configuration.DeprecationDelta[]"/>
<doc>
<![CDATA[Adds a set of deprecated keys to the global deprecations.
This method is lockless. It works by means of creating a new
DeprecationContext based on the old one, and then atomically swapping in
the new context. If someone else updated the context in between us reading
the old context and swapping in the new one, we try again until we win the
race.
@param deltas The deprecations to add.]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="use {@link #addDeprecation(String key, String newKey,
String customMessage)} instead">
<param name="key" type="java.lang.String"/>
<param name="newKeys" type="java.lang.String[]"/>
<param name="customMessage" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If a key is deprecated in favor of multiple keys, they are all treated as
aliases of each other, and setting any one of them resets all the others
to the new value.
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key
@param newKeys
@param customMessage
@deprecated use {@link #addDeprecation(String key, String newKey,
String customMessage)} instead]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<param name="newKey" type="java.lang.String"/>
<param name="customMessage" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key
@param newKey
@param customMessage]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="use {@link #addDeprecation(String key, String newKey)} instead">
<param name="key" type="java.lang.String"/>
<param name="newKeys" type="java.lang.String[]"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map when no custom
message is provided.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If a key is deprecated in favor of multiple keys, they are all treated as
aliases of each other, and setting any one of them resets all the others
to the new value.
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key Key that is to be deprecated
@param newKeys list of keys that take up the values of deprecated key
@deprecated use {@link #addDeprecation(String key, String newKey)} instead]]>
</doc>
</method>
<method name="addDeprecation"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<param name="newKey" type="java.lang.String"/>
<doc>
<![CDATA[Adds the deprecated key to the global deprecation map when no custom
message is provided.
It does not override any existing entries in the deprecation map.
This is to be used only by the developers in order to add deprecation of
keys, and attempts to call this method after loading resources once,
would lead to <tt>UnsupportedOperationException</tt>
If you have multiple deprecation entries to add, it is more efficient to
use #addDeprecations(DeprecationDelta[] deltas) instead.
@param key Key that is to be deprecated
@param newKey key that takes up the value of deprecated key]]>
</doc>
</method>
<method name="isDeprecated" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="key" type="java.lang.String"/>
<doc>
<![CDATA[checks whether the given <code>key</code> is deprecated.
@param key the parameter which is to be checked for deprecation
@return <code>true</code> if the key is deprecated and
<code>false</code> otherwise.]]>
</doc>
</method>
<method name="setDeprecatedProperties"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Sets all deprecated properties that are not currently set but have a
corresponding new property that is set. Useful for iterating the
properties when all deprecated properties for currently set properties
need to be present.]]>
</doc>
</method>
<method name="addDefaultResource"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a default resource. Resources are loaded in the order of the resources
added.
@param name file name. File should be present in the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param name resource to be added, the classpath is examined for a file
with that name.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="url" type="java.net.URL"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param url url of the resource to be added, the local filesystem is
examined directly to find the resource, without referring to
the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="file" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param file file-path of resource to be added, the local filesystem is
examined directly to find the resource, without referring to
the classpath.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.InputStream"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
WARNING: The contents of the InputStream will be cached, by this method.
So use this sparingly because it does increase the memory consumption.
@param in InputStream to deserialize the object from. In will be read from
when a get or set is called next. After it is read the stream will be
closed.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.InputStream"/>
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param in InputStream to deserialize the object from.
@param name the name of the resource because InputStream.toString is not
very descriptive some times.]]>
</doc>
</method>
<method name="addResource"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[Add a configuration resource.
The properties of this resource will override properties of previously
added resources, unless they were marked <a href="#Final">final</a>.
@param conf Configuration object from which to load properties]]>
</doc>
</method>
<method name="reloadConfiguration"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Reload configuration from previously added resources.
This method will clear all the configuration read from the added
resources, and final parameters. This will make the resources to
be read again before accessing the values. Values that are added
via set methods will overlay values read from the resources.]]>
</doc>
</method>
<method name="get" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property, <code>null</code> if
no such property exists. If the key is deprecated, it returns the value of
the first key which replaces the deprecated key and is not null.
Values are processed for <a href="#VariableExpansion">variable expansion</a>
before being returned.
@param name the property name, will be trimmed before get value.
@return the value of the <code>name</code> or its replacing property,
or null if no such property exists.]]>
</doc>
</method>
<method name="setAllowNullValueProperties"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="val" type="boolean"/>
<doc>
<![CDATA[Set Configuration to allow keys without values during setup. Intended
for use during testing.
@param val If true, will allow Configuration to store keys without values]]>
</doc>
</method>
<method name="onlyKeyExists" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Return existence of the <code>name</code> property, but only for
names which have no valid value, usually non-existent or commented
out in XML.
@param name the property name
@return true if the property <code>name</code> exists without value]]>
</doc>
</method>
<method name="getTrimmed" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
<code>null</code> if no such property exists.
If the key is deprecated, it returns the value of
the first key which replaces the deprecated key and is not null
Values are processed for <a href="#VariableExpansion">variable expansion</a>
before being returned.
@param name the property name.
@return the value of the <code>name</code> or its replacing property,
or null if no such property exists.]]>
</doc>
</method>
<method name="getTrimmed" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>,
<code>defaultValue</code> if no such property exists.
See @{Configuration#getTrimmed} for more details.
@param name the property name.
@param defaultValue the property default value.
@return the value of the <code>name</code> or defaultValue
if it is not set.]]>
</doc>
</method>
<method name="getRaw" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property, without doing
<a href="#VariableExpansion">variable expansion</a>.If the key is
deprecated, it returns the value of the first key which replaces
the deprecated key and is not null.
@param name the property name.
@return the value of the <code>name</code> property or
its replacing property and null if no such property exists.]]>
</doc>
</method>
<method name="set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<doc>
<![CDATA[Set the <code>value</code> of the <code>name</code> property. If
<code>name</code> is deprecated or there is a deprecated name associated to it,
it sets the value to both names. Name will be trimmed before put into
configuration.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<param name="source" type="java.lang.String"/>
<doc>
<![CDATA[Set the <code>value</code> of the <code>name</code> property. If
<code>name</code> is deprecated, it also sets the <code>value</code> to
the keys that replace the deprecated key. Name will be trimmed before put
into configuration.
@param name property name.
@param value property value.
@param source the place that this configuration value came from
(For debugging).
@throws IllegalArgumentException when the value or name is null.]]>
</doc>
</method>
<method name="unset"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Unset a previously set property.]]>
</doc>
</method>
<method name="setIfUnset"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="java.lang.String"/>
<doc>
<![CDATA[Sets a property if it is currently unset.
@param name the property name
@param value the new value]]>
</doc>
</method>
<method name="get" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code>. If the key is deprecated,
it returns the value of the first key which replaces the deprecated key
and is not null.
If no such property exists,
then <code>defaultValue</code> is returned.
@param name property name, will be trimmed before get value.
@param defaultValue default value.
@return property value, or <code>defaultValue</code> if the property
doesn't exist.]]>
</doc>
</method>
<method name="getInt" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="int"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as an <code>int</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>int</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as an <code>int</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getInts" return="int[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a set of comma-delimited
<code>int</code> values.
If no such property exists, an empty array is returned.
@param name property name
@return property value interpreted as an array of comma-delimited
<code>int</code> values]]>
</doc>
</method>
<method name="setInt"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="int"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to an <code>int</code>.
@param name property name.
@param value <code>int</code> value of the property.]]>
</doc>
</method>
<method name="getLong" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>long</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>long</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>long</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getLongBytes" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>long</code> or
human readable format. If no such property exists, the provided default
value is returned, or if the specified value is not a valid
<code>long</code> or human readable format, then an error is thrown. You
can use the following suffix (case insensitive): k(kilo), m(mega), g(giga),
t(tera), p(peta), e(exa)
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>long</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setLong"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="long"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>long</code>.
@param name property name.
@param value <code>long</code> value of the property.]]>
</doc>
</method>
<method name="getFloat" return="float"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="float"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>float</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>float</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>float</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setFloat"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="float"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>float</code>.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="getDouble" return="double"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="double"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>double</code>.
If no such property exists, the provided default value is returned,
or if the specified value is not a valid <code>double</code>,
then an error is thrown.
@param name property name.
@param defaultValue default value.
@throws NumberFormatException when the value is invalid
@return property value as a <code>double</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setDouble"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="double"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>double</code>.
@param name property name.
@param value property value.]]>
</doc>
</method>
<method name="getBoolean" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="boolean"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>boolean</code>.
If no such property is specified, or if the specified value is not a valid
<code>boolean</code>, then <code>defaultValue</code> is returned.
@param name property name.
@param defaultValue default value.
@return property value as a <code>boolean</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="setBoolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="boolean"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to a <code>boolean</code>.
@param name property name.
@param value <code>boolean</code> value of the property.]]>
</doc>
</method>
<method name="setBooleanIfUnset"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="boolean"/>
<doc>
<![CDATA[Set the given property, if it is currently unset.
@param name property name
@param value new value]]>
</doc>
</method>
<method name="setEnum"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="T"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to the given type. This
is equivalent to <code>set(&lt;name&gt;, value.toString())</code>.
@param name property name
@param value new value]]>
</doc>
</method>
<method name="getEnum" return="T"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="T"/>
<doc>
<![CDATA[Return value matching this enumerated type.
Note that the returned value is trimmed by this method.
@param name Property name
@param defaultValue Value returned if no mapping exists
@throws IllegalArgumentException If mapping is illegal for the type
provided]]>
</doc>
</method>
<method name="setTimeDuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="value" type="long"/>
<param name="unit" type="java.util.concurrent.TimeUnit"/>
<doc>
<![CDATA[Set the value of <code>name</code> to the given time duration. This
is equivalent to <code>set(&lt;name&gt;, value + &lt;time suffix&gt;)</code>.
@param name Property name
@param value Time duration
@param unit Unit of time]]>
</doc>
</method>
<method name="getTimeDuration" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="long"/>
<param name="unit" type="java.util.concurrent.TimeUnit"/>
<doc>
<![CDATA[Return time duration in the given time unit. Valid units are encoded in
properties as suffixes: nanoseconds (ns), microseconds (us), milliseconds
(ms), seconds (s), minutes (m), hours (h), and days (d).
@param name Property name
@param defaultValue Value returned if no mapping exists.
@param unit Unit to convert the stored property, if it exists.
@throws NumberFormatException If the property stripped of its unit is not
a number]]>
</doc>
</method>
<method name="getPattern" return="java.util.regex.Pattern"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.util.regex.Pattern"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Pattern</code>.
If no such property is specified, or if the specified value is not a valid
<code>Pattern</code>, then <code>DefaultValue</code> is returned.
Note that the returned value is NOT trimmed by this method.
@param name property name
@param defaultValue default value
@return property value as a compiled Pattern, or defaultValue]]>
</doc>
</method>
<method name="setPattern"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="pattern" type="java.util.regex.Pattern"/>
<doc>
<![CDATA[Set the given property to <code>Pattern</code>.
If the pattern is passed as null, sets the empty pattern which results in
further calls to getPattern(...) returning the default value.
@param name property name
@param pattern new value]]>
</doc>
</method>
<method name="getPropertySources" return="java.lang.String[]"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Gets information about why a property was set. Typically this is the
path to the resource objects (file, URL, etc.) the property came from, but
it can also indicate that it was set programatically, or because of the
command line.
@param name - The property name to get the source of.
@return null - If the property or its source wasn't found. Otherwise,
returns a list of the sources of the resource. The older sources are
the first ones in the list. So for example if a configuration is set from
the command line, and then written out to a file that is read back in the
first entry would indicate that it was set from the command line, while
the second one would indicate the file that the new configuration was read
in from.]]>
</doc>
</method>
<method name="getRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String"/>
<doc>
<![CDATA[Parse the given attribute as a set of integer ranges
@param name the attribute name
@param defaultValue the default value if it is not set
@return a new set of ranges from the configured value]]>
</doc>
</method>
<method name="getStringCollection" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
a collection of <code>String</code>s.
If no such property is specified then empty collection is returned.
<p>
This is an optimized version of {@link #getStrings(String)}
@param name property name.
@return property value as a collection of <code>String</code>s.]]>
</doc>
</method>
<method name="getStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s.
If no such property is specified then <code>null</code> is returned.
@param name property name.
@return property value as an array of <code>String</code>s,
or <code>null</code>.]]>
</doc>
</method>
<method name="getStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String[]"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s.
If no such property is specified then default value is returned.
@param name property name.
@param defaultValue The default value
@return property value as an array of <code>String</code>s,
or default value.]]>
</doc>
</method>
<method name="getTrimmedStringCollection" return="java.util.Collection"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
a collection of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then empty <code>Collection</code> is returned.
@param name property name.
@return property value as a collection of <code>String</code>s, or empty <code>Collection</code>]]>
</doc>
</method>
<method name="getTrimmedStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then an empty array is returned.
@param name property name.
@return property value as an array of trimmed <code>String</code>s,
or empty array.]]>
</doc>
</method>
<method name="getTrimmedStrings" return="java.lang.String[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.String[]"/>
<doc>
<![CDATA[Get the comma delimited values of the <code>name</code> property as
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
If no such property is specified then default value is returned.
@param name property name.
@param defaultValue The default value
@return property value as an array of trimmed <code>String</code>s,
or default value.]]>
</doc>
</method>
<method name="setStrings"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="values" type="java.lang.String[]"/>
<doc>
<![CDATA[Set the array of string values for the <code>name</code> property as
as comma delimited values.
@param name property name.
@param values The values]]>
</doc>
</method>
<method name="getPassword" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the value for a known password configuration element.
In order to enable the elimination of clear text passwords in config,
this method attempts to resolve the property name as an alias through
the CredentialProvider API and conditionally fallsback to config.
@param name property name
@return password]]>
</doc>
</method>
<method name="getPasswordFromCredentialProviders" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Try and resolve the provided element name as a credential provider
alias.
@param name alias of the provisioned credential
@return password or null if not found
@throws IOException]]>
</doc>
</method>
<method name="getPasswordFromConfig" return="char[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Fallback to clear text passwords in configuration.
@param name
@return clear text password or null]]>
</doc>
</method>
<method name="getSocketAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="hostProperty" type="java.lang.String"/>
<param name="addressProperty" type="java.lang.String"/>
<param name="defaultAddressValue" type="java.lang.String"/>
<param name="defaultPort" type="int"/>
<doc>
<![CDATA[Get the socket address for <code>hostProperty</code> as a
<code>InetSocketAddress</code>. If <code>hostProperty</code> is
<code>null</code>, <code>addressProperty</code> will be used. This
is useful for cases where we want to differentiate between host
bind address and address clients should use to establish connection.
@param hostProperty bind host property name.
@param addressProperty address property name.
@param defaultAddressValue the default value
@param defaultPort the default port
@return InetSocketAddress]]>
</doc>
</method>
<method name="getSocketAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultAddress" type="java.lang.String"/>
<param name="defaultPort" type="int"/>
<doc>
<![CDATA[Get the socket address for <code>name</code> property as a
<code>InetSocketAddress</code>.
@param name property name.
@param defaultAddress the default value
@param defaultPort the default port
@return InetSocketAddress]]>
</doc>
</method>
<method name="setSocketAddr"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address for the <code>name</code> property as
a <code>host:port</code>.]]>
</doc>
</method>
<method name="updateConnectAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="hostProperty" type="java.lang.String"/>
<param name="addressProperty" type="java.lang.String"/>
<param name="defaultAddressValue" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address a client can use to connect for the
<code>name</code> property as a <code>host:port</code>. The wildcard
address is replaced with the local host's address. If the host and address
properties are configured the host component of the address will be combined
with the port component of the addr to generate the address. This is to allow
optional control over which host name is used in multi-home bind-host
cases where a host can have multiple names
@param hostProperty the bind-host configuration name
@param addressProperty the service address configuration name
@param defaultAddressValue the service default address configuration value
@param addr InetSocketAddress of the service listener
@return InetSocketAddress for clients to connect]]>
</doc>
</method>
<method name="updateConnectAddr" return="java.net.InetSocketAddress"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="addr" type="java.net.InetSocketAddress"/>
<doc>
<![CDATA[Set the socket address a client can use to connect for the
<code>name</code> property as a <code>host:port</code>. The wildcard
address is replaced with the local host's address.
@param name property name.
@param addr InetSocketAddress of a listener to store in the given property
@return InetSocketAddress for clients to connect]]>
</doc>
</method>
<method name="getClassByName" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
<doc>
<![CDATA[Load a class by name.
@param name the class name.
@return the class object.
@throws ClassNotFoundException if the class is not found.]]>
</doc>
</method>
<method name="getClassByNameOrNull" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Load a class by name, returning null rather than throwing an exception
if it couldn't be loaded. This is to avoid the overhead of creating
an exception.
@param name the class name
@return the class object, or null if it could not be found.]]>
</doc>
</method>
<method name="getClasses" return="java.lang.Class[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class[]"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property
as an array of <code>Class</code>.
The value of the property specifies a list of comma separated class names.
If no such property is specified, then <code>defaultValue</code> is
returned.
@param name the property name.
@param defaultValue default value.
@return property value as a <code>Class[]</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getClass" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>.
If no such property is specified, then <code>defaultValue</code> is
returned.
@param name the class name.
@param defaultValue default value.
@return property value as a <code>Class</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getClass" return="java.lang.Class"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="defaultValue" type="java.lang.Class"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>
implementing the interface specified by <code>xface</code>.
If no such property is specified, then <code>defaultValue</code> is
returned.
An exception is thrown if the returned class does not implement the named
interface.
@param name the class name.
@param defaultValue default value.
@param xface the interface implemented by the named class.
@return property value as a <code>Class</code>,
or <code>defaultValue</code>.]]>
</doc>
</method>
<method name="getInstances" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Get the value of the <code>name</code> property as a <code>List</code>
of objects implementing the interface specified by <code>xface</code>.
An exception is thrown if any of the classes does not exist, or if it does
not implement the named interface.
@param name the property name.
@param xface the interface implemented by the classes named by
<code>name</code>.
@return a <code>List</code> of objects implementing <code>xface</code>.]]>
</doc>
</method>
<method name="setClass"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="theClass" type="java.lang.Class"/>
<param name="xface" type="java.lang.Class"/>
<doc>
<![CDATA[Set the value of the <code>name</code> property to the name of a
<code>theClass</code> implementing the given interface <code>xface</code>.
An exception is thrown if <code>theClass</code> does not implement the
interface <code>xface</code>.
@param name property name.
@param theClass property value.
@param xface the interface implemented by the named class.]]>
</doc>
</method>
<method name="getLocalPath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dirsProp" type="java.lang.String"/>
<param name="path" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a local file under a directory named by <i>dirsProp</i> with
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
then one is chosen based on <i>path</i>'s hash code. If the selected
directory does not exist, an attempt is made to create it.
@param dirsProp directory in which to locate the file.
@param path file-path.
@return local file under the directory with the given path.]]>
</doc>
</method>
<method name="getFile" return="java.io.File"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dirsProp" type="java.lang.String"/>
<param name="path" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get a local file name under a directory named in <i>dirsProp</i> with
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
then one is chosen based on <i>path</i>'s hash code. If the selected
directory does not exist, an attempt is made to create it.
@param dirsProp directory in which to locate the file.
@param path file-path.
@return local file under the directory with the given path.]]>
</doc>
</method>
<method name="getResource" return="java.net.URL"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get the {@link URL} for the named resource.
@param name resource name.
@return the url for the named resource.]]>
</doc>
</method>
<method name="getConfResourceAsInputStream" return="java.io.InputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get an input stream attached to the configuration resource with the
given <code>name</code>.
@param name configuration resource name.
@return an input stream attached to the resource.]]>
</doc>
</method>
<method name="getConfResourceAsReader" return="java.io.Reader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Get a {@link Reader} attached to the configuration resource with the
given <code>name</code>.
@param name configuration resource name.
@return a reader attached to the resource.]]>
</doc>
</method>
<method name="getFinalParameters" return="java.util.Set"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the set of parameters marked final.
@return final parameter set.]]>
</doc>
</method>
<method name="getProps" return="java.util.Properties"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="size" return="int"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the number of keys in the configuration.
@return number of keys in the configuration.]]>
</doc>
</method>
<method name="clear"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Clears all keys from the configuration.]]>
</doc>
</method>
<method name="iterator" return="java.util.Iterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get an {@link Iterator} to go through the list of <code>String</code>
key-value pairs in the configuration.
@return an iterator over the entries.]]>
</doc>
</method>
<method name="writeXml"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.OutputStream"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Write out the non-default properties in this configuration to the given
{@link OutputStream} using UTF-8 encoding.
@param out the output stream to write to.]]>
</doc>
</method>
<method name="writeXml"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.Writer"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Write out the non-default properties in this configuration to the given
{@link Writer}.
@param out the writer to write to.]]>
</doc>
</method>
<method name="dumpConfiguration"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="config" type="org.apache.hadoop.conf.Configuration"/>
<param name="out" type="java.io.Writer"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Writes out all the parameters and their properties (final and resource) to
the given {@link Writer}
The format of the output would be
{ "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2,
key2.isFinal,key2.resource}... ] }
It does not output the parameters of the configuration object which is
loaded from an input stream.
@param out the Writer to write to
@throws IOException]]>
</doc>
</method>
<method name="getClassLoader" return="java.lang.ClassLoader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get the {@link ClassLoader} for this job.
@return the correct class loader.]]>
</doc>
</method>
<method name="setClassLoader"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="classLoader" type="java.lang.ClassLoader"/>
<doc>
<![CDATA[Set the class loader that will be used to load the various objects.
@param classLoader the new class loader.]]>
</doc>
</method>
<method name="toString" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="setQuietMode"
abstract="false" native="false" synchronized="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="quietmode" type="boolean"/>
<doc>
<![CDATA[Set the quietness-mode.
In the quiet-mode, error and informational messages might not be logged.
@param quietmode <code>true</code> to set quiet-mode on, <code>false</code>
to turn it off.]]>
</doc>
</method>
<method name="main"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="args" type="java.lang.String[]"/>
<exception name="Exception" type="java.lang.Exception"/>
<doc>
<![CDATA[For debugging. List non-default properties to the terminal and exit.]]>
</doc>
</method>
<method name="readFields"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="in" type="java.io.DataInput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="write"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="out" type="java.io.DataOutput"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getValByRegex" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="regex" type="java.lang.String"/>
<doc>
<![CDATA[get keys matching the the regex
@param regex
@return Map<String,String> with matching keys]]>
</doc>
</method>
<method name="dumpDeprecatedKeys"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="hasWarnedDeprecation" return="boolean"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<doc>
<![CDATA[Returns whether or not a deprecated name has been warned. If the name is not
deprecated then always return false]]>
</doc>
</method>
<doc>
<![CDATA[Provides access to configuration parameters.
<h4 id="Resources">Resources</h4>
<p>Configurations are specified by resources. A resource contains a set of
name/value pairs as XML data. Each resource is named by either a
<code>String</code> or by a {@link Path}. If named by a <code>String</code>,
then the classpath is examined for a file with that name. If named by a
<code>Path</code>, then the local filesystem is examined directly, without
referring to the classpath.
<p>Unless explicitly turned off, Hadoop by default specifies two
resources, loaded in-order from the classpath: <ol>
<li><tt>
<a href="{@docRoot}/../hadoop-project-dist/hadoop-common/core-default.xml">
core-default.xml</a></tt>: Read-only defaults for hadoop.</li>
<li><tt>core-site.xml</tt>: Site-specific configuration for a given hadoop
installation.</li>
</ol>
Applications may add additional resources, which are loaded
subsequent to these resources in the order they are added.
<h4 id="FinalParams">Final Parameters</h4>
<p>Configuration parameters may be declared <i>final</i>.
Once a resource declares a value final, no subsequently-loaded
resource can alter that value.
For example, one might define a final parameter with:
<tt><pre>
&lt;property&gt;
&lt;name&gt;dfs.hosts.include&lt;/name&gt;
&lt;value&gt;/etc/hadoop/conf/hosts.include&lt;/value&gt;
<b>&lt;final&gt;true&lt;/final&gt;</b>
&lt;/property&gt;</pre></tt>
Administrators typically define parameters as final in
<tt>core-site.xml</tt> for values that user applications may not alter.
<h4 id="VariableExpansion">Variable Expansion</h4>
<p>Value strings are first processed for <i>variable expansion</i>. The
available properties are:<ol>
<li>Other properties defined in this Configuration; and, if a name is
undefined here,</li>
<li>Properties in {@link System#getProperties()}.</li>
</ol>
<p>For example, if a configuration resource contains the following property
definitions:
<tt><pre>
&lt;property&gt;
&lt;name&gt;basedir&lt;/name&gt;
&lt;value&gt;/user/${<i>user.name</i>}&lt;/value&gt;
&lt;/property&gt;
&lt;property&gt;
&lt;name&gt;tempdir&lt;/name&gt;
&lt;value&gt;${<i>basedir</i>}/tmp&lt;/value&gt;
&lt;/property&gt;</pre></tt>
When <tt>conf.get("tempdir")</tt> is called, then <tt>${<i>basedir</i>}</tt>
will be resolved to another property in this Configuration, while
<tt>${<i>user.name</i>}</tt> would then ordinarily be resolved to the value
of the System property with that name.
By default, warnings will be given to any deprecated configuration
parameters and these are suppressible by configuring
<tt>log4j.logger.org.apache.hadoop.conf.Configuration.deprecation</tt> in
log4j.properties file.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configuration -->
<!-- start class org.apache.hadoop.conf.Configured -->
<class name="Configured" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<implements name="org.apache.hadoop.conf.Configurable"/>
<constructor name="Configured"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a Configured.]]>
</doc>
</constructor>
<constructor name="Configured" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Construct a Configured.]]>
</doc>
</constructor>
<method name="setConf"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
</method>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<doc>
<![CDATA[Base class for things that may be configured with a {@link Configuration}.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.conf.Configured -->
<!-- start class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
<class name="ReconfigurationTaskStatus" extends="java.lang.Object"
abstract="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="ReconfigurationTaskStatus" type="long, long, java.util.Map"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="hasTask" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return true if
- A reconfiguration task has finished or
- an active reconfiguration task is running]]>
</doc>
</method>
<method name="stopped" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return true if the latest reconfiguration task has finished and there is
no another active task running.]]>
</doc>
</method>
<method name="getStartTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getEndTime" return="long"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="getStatus" return="java.util.Map"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
</method>
</class>
<!-- end class org.apache.hadoop.conf.ReconfigurationTaskStatus -->
<doc>
<![CDATA[Configuration of system parameters.]]>
</doc>
</package>
<package name="org.apache.hadoop.crypto">
</package>
<package name="org.apache.hadoop.crypto.key">
<!-- start class org.apache.hadoop.crypto.key.KeyProvider -->
<class name="KeyProvider" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProvider" type="org.apache.hadoop.conf.Configuration"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Constructor.
@param conf configuration for the provider]]>
</doc>
</constructor>
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the provider configuration.
@return the provider configuration]]>
</doc>
</method>
<method name="options" return="org.apache.hadoop.crypto.key.KeyProvider.Options"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<doc>
<![CDATA[A helper function to create an options object.
@param conf the configuration to use
@return a new options object]]>
</doc>
</method>
<method name="isTransient" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Indicates whether this provider represents a store
that is intended for transient use - such as the UserProvider
is. These providers are generally used to provide access to
keying material rather than for long term storage.
@return true if transient, false otherwise]]>
</doc>
</method>
<method name="getKeyVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key material for a specific version of the key. This method is used
when decrypting data.
@param versionName the name of a specific version of the key
@return the key material
@throws IOException]]>
</doc>
</method>
<method name="getKeys" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key names for all keys.
@return the list of key names
@throws IOException]]>
</doc>
</method>
<method name="getKeysMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="names" type="java.lang.String[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get key metadata in bulk.
@param names the names of the keys to get
@throws IOException]]>
</doc>
</method>
<method name="getKeyVersions" return="java.util.List"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the key material for all versions of a specific key name.
@return the list of key material
@throws IOException]]>
</doc>
</method>
<method name="getCurrentKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get the current version of the key, which should be used for encrypting new
data.
@param name the base name of the key
@return the version name of the current version of the key or null if the
key version doesn't exist
@throws IOException]]>
</doc>
</method>
<method name="getMetadata" return="org.apache.hadoop.crypto.key.KeyProvider.Metadata"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Get metadata about the key.
@param name the basename of the key
@return the key's metadata or null if the key doesn't exist
@throws IOException]]>
</doc>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a new key. The given key must not already exist.
@param name the base name of the key
@param material the key material for the first version of the key.
@param options the options for the new key.
@return the version name of the first version of the key.
@throws IOException]]>
</doc>
</method>
<method name="generateKey" return="byte[]"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="protected"
deprecated="not deprecated">
<param name="size" type="int"/>
<param name="algorithm" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<doc>
<![CDATA[Generates a key material.
@param size length of the key.
@param algorithm algorithm to use for generating the key.
@return the generated key.
@throws NoSuchAlgorithmException]]>
</doc>
</method>
<method name="createKey" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="options" type="org.apache.hadoop.crypto.key.KeyProvider.Options"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a new key generating the material for it.
The given key must not already exist.
<p/>
This implementation generates the key material and calls the
{@link #createKey(String, byte[], Options)} method.
@param name the base name of the key
@param options the options for the new key.
@return the version name of the first version of the key.
@throws IOException
@throws NoSuchAlgorithmException]]>
</doc>
</method>
<method name="deleteKey"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Delete the given key.
@param name the name of the key to delete
@throws IOException]]>
</doc>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="material" type="byte[]"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Roll a new version of the given key.
@param name the basename of the key
@param material the new key material
@return the name of the new version of the key
@throws IOException]]>
</doc>
</method>
<method name="close"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Can be used by implementing classes to close any resources
that require closing]]>
</doc>
</method>
<method name="rollNewVersion" return="org.apache.hadoop.crypto.key.KeyProvider.KeyVersion"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<exception name="NoSuchAlgorithmException" type="java.security.NoSuchAlgorithmException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Roll a new version of the given key generating the material for it.
<p/>
This implementation generates the key material and calls the
{@link #rollNewVersion(String, byte[])} method.
@param name the basename of the key
@return the name of the new version of the key
@throws IOException]]>
</doc>
</method>
<method name="flush"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Ensures that any changes to the keys are written to persistent store.
@throws IOException]]>
</doc>
</method>
<method name="getBaseName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="versionName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Split the versionName in to a base name. Converts "/aaa/bbb/3" to
"/aaa/bbb".
@param versionName the version name to split
@return the base name of the key
@throws IOException]]>
</doc>
</method>
<method name="buildVersionName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="name" type="java.lang.String"/>
<param name="version" type="int"/>
<doc>
<![CDATA[Build a version string from a basename and version number. Converts
"/aaa/bbb" and 3 to "/aaa/bbb@3".
@param name the basename of the key
@param version the version of the key
@return the versionName of the key.]]>
</doc>
</method>
<method name="findProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerList" type="java.util.List"/>
<param name="keyName" type="java.lang.String"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Find the provider with the given key.
@param providerList the list of providers
@param keyName the key name we are looking for
@return the KeyProvider that has the key]]>
</doc>
</method>
<field name="DEFAULT_CIPHER_NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_CIPHER" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_BITLENGTH_NAME" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<field name="DEFAULT_BITLENGTH" type="int"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A provider of secret key material for Hadoop applications. Provides an
abstraction to separate key storage from users of encryption. It
is intended to support getting or storing keys in a variety of ways,
including third party bindings.
<P/>
<code>KeyProvider</code> implementations must be thread safe.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProvider -->
<!-- start class org.apache.hadoop.crypto.key.KeyProviderFactory -->
<class name="KeyProviderFactory" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="KeyProviderFactory"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</constructor>
<method name="createProvider" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="providerName" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="getProviders" return="java.util.List"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
</method>
<method name="get" return="org.apache.hadoop.crypto.key.KeyProvider"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Create a KeyProvider based on a provided URI.
@param uri key provider URI
@param conf configuration to initialize the key provider
@return the key provider for the specified URI, or <code>NULL</code> if
a provider for the specified URI scheme could not be found.
@throws IOException thrown if the provider failed to initialize.]]>
</doc>
</method>
<field name="KEY_PROVIDER_PATH" type="java.lang.String"
transient="false" volatile="false"
static="true" final="true" visibility="public"
deprecated="not deprecated">
</field>
<doc>
<![CDATA[A factory to create a list of KeyProvider based on the path given in a
Configuration. It uses a service loader interface to find the available
KeyProviders and create them based on the list of URIs.]]>
</doc>
</class>
<!-- end class org.apache.hadoop.crypto.key.KeyProviderFactory -->
</package>
<package name="org.apache.hadoop.crypto.key.kms">
</package>
<package name="org.apache.hadoop.crypto.random">
</package>
<package name="org.apache.hadoop.fs">
<!-- start class org.apache.hadoop.fs.AbstractFileSystem -->
<class name="AbstractFileSystem" extends="java.lang.Object"
abstract="true"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<constructor name="AbstractFileSystem" type="java.net.URI, java.lang.String, boolean, int"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="URISyntaxException" type="java.net.URISyntaxException"/>
<doc>
<![CDATA[Constructor to be called by subclasses.
@param uri for this file system.
@param supportedScheme the scheme supported by the implementor
@param authorityNeeded if true then theURI must have authority, if false
then the URI must have null authority.
@throws URISyntaxException <code>uri</code> has syntax error]]>
</doc>
</constructor>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="isValidName" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="java.lang.String"/>
<doc>
<![CDATA[Returns true if the specified string is considered valid in the path part
of a URI by this file system. The default implementation enforces the rules
of HDFS, but subclasses may override this method to implement specific
validation rules for specific file systems.
@param src String source filename to check, path part of the URI
@return boolean true if the specified string is considered valid]]>
</doc>
</method>
<method name="createFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[Create a file system instance for the specified uri using the conf. The
conf is used to find the class name that implements the file system. The
conf is also passed to the file system for its configuration.
@param uri URI of the file system
@param conf Configuration for the file system
@return Returns the file system for the given URI
@throws UnsupportedFileSystemException file system for <code>uri</code> is
not found]]>
</doc>
</method>
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<doc>
<![CDATA[Get the statistics for a particular file system.
@param uri
used as key to lookup STATISTICS_TABLE. Only scheme and authority
part of the uri are used.
@return a statistics object]]>
</doc>
</method>
<method name="clearStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
</method>
<method name="printStatistics"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Prints statistics for all file systems.]]>
</doc>
</method>
<method name="getAllStatistics" return="java.util.Map"
abstract="false" native="false" synchronized="true"
static="true" final="false" visibility="protected"
deprecated="not deprecated">
</method>
<method name="get" return="org.apache.hadoop.fs.AbstractFileSystem"
abstract="false" native="false" synchronized="false"
static="true" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<doc>
<![CDATA[The main factory method for creating a file system. Get a file system for
the URI's scheme and authority. The scheme of the <code>uri</code>
determines a configuration property name,
<tt>fs.AbstractFileSystem.<i>scheme</i>.impl</tt> whose value names the
AbstractFileSystem class.
The entire URI and conf is passed to the AbstractFileSystem factory method.
@param uri for the file system to be created.
@param conf which is passed to the file system impl.
@return file system for the given URI.
@throws UnsupportedFileSystemException if the file system for
<code>uri</code> is not supported.]]>
</doc>
</method>
<method name="checkScheme"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="uri" type="java.net.URI"/>
<param name="supportedScheme" type="java.lang.String"/>
<doc>
<![CDATA[Check that the Uri's scheme matches
@param uri
@param supportedScheme]]>
</doc>
</method>
<method name="getUriDefaultPort" return="int"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[The default port of this file system.
@return default port of this file system's Uri scheme
A uri with a port of -1 => default port;]]>
</doc>
</method>
<method name="getUri" return="java.net.URI"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns a URI whose scheme and authority identify this FileSystem.
@return the uri of this file system.]]>
</doc>
</method>
<method name="checkPath"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Check that a Path belongs to this FileSystem.
If the path is fully qualified URI, then its scheme and authority
matches that of this file system. Otherwise the path must be
slash-relative name.
@throws InvalidPathException if the path is invalid]]>
</doc>
</method>
<method name="getUriPath" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Get the path-part of a pathname. Checks that URI matches this file system
and that the path-part is a valid name.
@param p path
@return path-part of the Path p]]>
</doc>
</method>
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<doc>
<![CDATA[Make the path fully qualified to this file system
@param path
@return the qualified path]]>
</doc>
</method>
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Some file systems like LocalFileSystem have an initial workingDir
that is used as the starting workingDir. For other file systems
like HDFS there is no built in notion of an initial workingDir.
@return the initial workingDir if the file system has such a notion
otherwise return a null.]]>
</doc>
</method>
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Return the current user's home directory in this file system.
The default implementation returns "/user/$USER/".
@return current user's home directory.]]>
</doc>
</method>
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return a set of server default configuration values.
@return server default configuration values
@throws IOException an I/O error occurred]]>
</doc>
</method>
<method name="resolvePath" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="p" type="org.apache.hadoop.fs.Path"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Return the fully-qualified path of path f resolving the path
through any internal symlinks or mount point
@param p path to be resolved
@return fully qualified path
@throws FileNotFoundException, AccessControlException, IOException
UnresolvedLinkException if symbolic link on path cannot be resolved
internally]]>
</doc>
</method>
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="createFlag" type="java.util.EnumSet"/>
<param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except
that the Path f must be fully qualified and the permission is absolute
(i.e. umask has been applied).]]>
</doc>
</method>
<method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="flag" type="java.util.EnumSet"/>
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="bufferSize" type="int"/>
<param name="replication" type="short"/>
<param name="blockSize" type="long"/>
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
<param name="checksumOpt" type="org.apache.hadoop.fs.Options.ChecksumOpt"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link #create(Path, EnumSet, Options.CreateOpts...)} except that the opts
have been declared explicitly.]]>
</doc>
</method>
<method name="mkdir"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="dir" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<param name="createParent" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#mkdir(Path, FsPermission, boolean)} except that the Path
f must be fully qualified and the permission is absolute (i.e.
umask has been applied).]]>
</doc>
</method>
<method name="delete" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="recursive" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#delete(Path, boolean)} except that Path f must be for
this file system.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#open(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="bufferSize" type="int"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#open(Path, int)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="truncate" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="newLength" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#truncate(Path, long)} except that Path f must be for
this file system.]]>
</doc>
</method>
<method name="setReplication" return="boolean"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="replication" type="short"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setReplication(Path, short)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="rename"
abstract="false" native="false" synchronized="false"
static="false" final="true" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system.]]>
</doc>
</method>
<method name="renameInternal"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system and NO OVERWRITE is performed.
File systems that do not have a built in overwrite need implement only this
method and can take advantage of the default impl of the other
{@link #renameInternal(Path, Path, boolean)}]]>
</doc>
</method>
<method name="renameInternal"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="src" type="org.apache.hadoop.fs.Path"/>
<param name="dst" type="org.apache.hadoop.fs.Path"/>
<param name="overwrite" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
f must be for this file system.]]>
</doc>
</method>
<method name="supportsSymlinks" return="boolean"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Returns true if the file system supports symlinks, false otherwise.
@return true if filesystem supports symlinks]]>
</doc>
</method>
<method name="createSymlink"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="target" type="org.apache.hadoop.fs.Path"/>
<param name="link" type="org.apache.hadoop.fs.Path"/>
<param name="createParent" type="boolean"/>
<exception name="IOException" type="java.io.IOException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#createSymlink(Path, Path, boolean)};]]>
</doc>
</method>
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Partially resolves the path. This is used during symlink resolution in
{@link FSLinkResolver}, and differs from the similarly named method
{@link FileContext#getLinkTarget(Path)}.
@throws IOException subclass implementations may throw IOException]]>
</doc>
</method>
<method name="setPermission"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setPermission(Path, FsPermission)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="setOwner"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="username" type="java.lang.String"/>
<param name="groupname" type="java.lang.String"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setOwner(Path, String, String)} except that Path f must
be for this file system.]]>
</doc>
</method>
<method name="setTimes"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="mtime" type="long"/>
<param name="atime" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setTimes(Path, long, long)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileChecksum(Path)} except that Path f must be for
this file system.]]>
</doc>
</method>
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileStatus(Path)}
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path.]]>
</doc>
</method>
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileLinkStatus(Path)}
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path leading up to the final path component.
If the file system does not support symlinks then the behavior is
equivalent to {@link AbstractFileSystem#getFileStatus(Path)}.]]>
</doc>
</method>
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<param name="start" type="long"/>
<param name="len" type="long"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFileBlockLocations(Path, long, long)} except that
Path f must be for this file system.]]>
</doc>
</method>
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFsStatus(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#getFsStatus(Path)}.]]>
</doc>
</method>
<method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#listStatus(Path)} except that Path f must be for this
file system.]]>
</doc>
</method>
<method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#listLocatedStatus(Path)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="f" type="org.apache.hadoop.fs.Path"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext.Util#listStatus(Path)} except that Path f must be
for this file system.]]>
</doc>
</method>
<method name="listCorruptFileBlocks" return="org.apache.hadoop.fs.RemoteIterator"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[@return an iterator over the corrupt files under the given path
(may contain duplicates if a file has more than one corrupt block)
@throws IOException]]>
</doc>
</method>
<method name="setVerifyChecksum"
abstract="true" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="verifyChecksum" type="boolean"/>
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[The specification of this method matches that of
{@link FileContext#setVerifyChecksum(boolean, Path)} except that Path f
must be for this file system.]]>
</doc>
</method>
<method name="getCanonicalServiceName" return="java.lang.String"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<doc>
<![CDATA[Get a canonical name for this file system.
@return a URI string that uniquely identifies this file system]]>
</doc>
</method>
<method name="modifyAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Modifies ACL entries of files and directories. This method can add new ACL
entries or modify the permissions on existing ACL entries. All existing
ACL entries that are not specified in this call are retained without
changes. (Modifications are merged into the current ACL.)
@param path Path to modify
@param aclSpec List<AclEntry> describing modifications
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAclEntries"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<param name="aclSpec" type="java.util.List"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes ACL entries from files and directories. Other ACL entries are
retained.
@param path Path to modify
@param aclSpec List<AclEntry> describing entries to remove
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeDefaultAcl"
abstract="false" native="false" synchronized="false"
static="false" final="false" visibility="public"
deprecated="not deprecated">
<param name="path" type="org.apache.hadoop.fs.Path"/>
<exception name="IOException" type="java.io.IOException"/>
<doc>
<![CDATA[Removes all default ACL entries from files and directories.
@param path Path to modify
@throws IOException if an ACL could not be modified]]>
</doc>
</method>
<method name="removeAcl"