| <?xml version="1.0" encoding="iso-8859-1" standalone="no"?> |
| <!-- Generated by the JDiff Javadoc doclet --> |
| <!-- (http://www.jdiff.org) --> |
| <!-- on Tue Aug 24 10:42:16 PDT 2010 --> |
| |
| <api |
| xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' |
| xsi:noNamespaceSchemaLocation='api.xsd' |
| name="hadoop-core 0.21.0" |
| jdversion="1.0.9"> |
| |
| <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/tom/workspace/hadoop-common-0.21-committer/build/hadoop-common-0.21.0.jar:/Users/tom/workspace/hadoop-common-0.21-committer/build/ivy/lib/Hadoop-Common/jdiff/jdiff-1.0.9.jar -classpath /Users/tom/workspace/hadoop-common-0.21-committer/build/classes:/Users/tom/workspace/hadoop-common-0.21-committer/conf:/Users/tom/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar:/Users/tom/.ivy2/cache/log4j/log4j/jars/log4j-1.2.15.jar:/Users/tom/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.1.jar:/Users/tom/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.4.jar:/Users/tom/.ivy2/cache/commons-cli/commons-cli/jars/commons-cli-1.2.jar:/Users/tom/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/Users/tom/.ivy2/cache/net.java.dev.jets3t/jets3t/jars/jets3t-0.7.1.jar:/Users/tom/.ivy2/cache/commons-net/commons-net/jars/commons-net-1.4.1.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/servlet-api-2.5/jars/servlet-api-2.5-6.1.14.jar:/Users/tom/.ivy2/cache/net.sf.kosmosfs/kfs/jars/kfs-0.3.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.14.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.14.jar:/Users/tom/.ivy2/cache/tomcat/jasper-runtime/jars/jasper-runtime-5.5.12.jar:/Users/tom/.ivy2/cache/tomcat/jasper-compiler/jars/jasper-compiler-5.5.12.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jsp-api-2.1/jars/jsp-api-2.1-6.1.14.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jsp-2.1/jars/jsp-2.1-6.1.14.jar:/Users/tom/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/Users/tom/.ivy2/cache/oro/oro/jars/oro-2.0.8.jar:/Users/tom/.ivy2/cache/jdiff/jdiff/jars/jdiff-1.0.9.jar:/Users/tom/.ivy2/cache/junit/junit/jars/junit-4.8.1.jar:/Users/tom/.ivy2/cache/hsqldb/hsqldb/jars/hsqldb-1.8.0.10.jar:/Users/tom/.ivy2/cache/commons-logging/commons-logging-api/jars/commons-logging-api-1.1.jar:/Users/tom/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.5.11.jar:/Users/tom/.ivy2/cache/org.eclipse.jdt/core/jars/core-3.1.1.jar:/Users/tom/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.5.11.jar:/Users/tom/.ivy2/cache/org.apache.hadoop/avro/jars/avro-1.3.2.jar:/Users/tom/.ivy2/cache/org.codehaus.jackson/jackson-mapper-asl/jars/jackson-mapper-asl-1.4.2.jar:/Users/tom/.ivy2/cache/org.codehaus.jackson/jackson-core-asl/jars/jackson-core-asl-1.4.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer/jars/paranamer-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer-ant/jars/paranamer-ant-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer-generator/jars/paranamer-generator-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.qdox/qdox/jars/qdox-1.10.1.jar:/Users/tom/.ivy2/cache/asm/asm/jars/asm-3.2.jar:/Users/tom/.ivy2/cache/commons-lang/commons-lang/jars/commons-lang-2.5.jar:/Users/tom/.ivy2/cache/org.aspectj/aspectjrt/jars/aspectjrt-1.6.5.jar:/Users/tom/.ivy2/cache/org.aspectj/aspectjtools/jars/aspectjtools-1.6.5.jar:/Users/tom/.ivy2/cache/org.mockito/mockito-all/jars/mockito-all-1.8.2.jar:/usr/share/ant/lib/ant-launcher.jar:/Users/tom/.ant/lib/ivy.jar:/usr/share/ant/lib/ant-antlr.jar:/usr/share/ant/lib/ant-jai.jar:/usr/share/ant/lib/ant-jmf.jar:/usr/share/ant/lib/ant-junit.jar:/usr/share/ant/lib/ant-nodeps.jar:/usr/share/ant/lib/ant-swing.jar:/usr/share/ant/lib/ant-testutil.jar:/usr/share/ant/lib/ant-trax.jar:/usr/share/ant/lib/ant.jar:/usr/share/ant/lib/ivy-2.1.0.jar:/usr/share/ant/lib/xercesImpl.jar:/usr/share/ant/lib/xml-apis.jar -sourcepath /Users/tom/workspace/hadoop-common-0.21-committer/src/java -apidir /Users/tom/workspace/hadoop-common-0.21-committer/lib/jdiff -apiname hadoop-core 0.21.0 --> |
| <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.classification"> |
| <!-- start class org.apache.hadoop.classification.InterfaceAudience --> |
| <class name="InterfaceAudience" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Annotation to inform users of a package, class or method's intended audience.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceAudience --> |
| <!-- start class org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate --> |
| <class name="InterfaceAudience.LimitedPrivate" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[Intended only for the project(s) specified in the annotation. |
| For example, "Common", "HDFS", "MapReduce", "ZooKeeper", "HBase".]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate --> |
| <!-- start class org.apache.hadoop.classification.InterfaceAudience.Private --> |
| <class name="InterfaceAudience.Private" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[Intended for use only within Hadoop itself.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceAudience.Private --> |
| <!-- start class org.apache.hadoop.classification.InterfaceAudience.Public --> |
| <class name="InterfaceAudience.Public" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[Intended for use by any project or application.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceAudience.Public --> |
| <!-- start class org.apache.hadoop.classification.InterfaceStability --> |
| <class name="InterfaceStability" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="InterfaceStability" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Annotation to inform users of how much to rely on a particular package, |
| class or method not changing over time.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceStability --> |
| <!-- start class org.apache.hadoop.classification.InterfaceStability.Evolving --> |
| <class name="InterfaceStability.Evolving" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[Evolving, but can break compatibility at minor release (i.e. m.x)]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceStability.Evolving --> |
| <!-- start class org.apache.hadoop.classification.InterfaceStability.Stable --> |
| <class name="InterfaceStability.Stable" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[Can evolve while retaining compatibility for minor release boundaries.; |
| can break compatibility only at major release (ie. at m.0).]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceStability.Stable --> |
| <!-- start class org.apache.hadoop.classification.InterfaceStability.Unstable --> |
| <class name="InterfaceStability.Unstable" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.annotation.Annotation"/> |
| <doc> |
| <![CDATA[No guarantee is provided as to reliability or stability across any |
| level of release granularity.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.classification.InterfaceStability.Unstable --> |
| </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="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[Set the configuration to be used by this object.]]> |
| </doc> |
| </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"> |
| <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="addDeprecation" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <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 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> |
| @param key |
| @param newKeys |
| @param customMessage]]> |
| </doc> |
| </method> |
| <method name="addDeprecation" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="java.lang.String"/> |
| <param name="newKeys" type="java.lang.String[]"/> |
| <doc> |
| <![CDATA[Adds the deprecated key to the 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> |
| |
| @param key Key that is to be deprecated |
| @param newKeys list of keys that take up the values of deprecated key]]> |
| </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>. |
| |
| @param in InputStream to deserialize the object from.]]> |
| </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. |
| @return the value of the <code>name</code> or its replacing property, |
| or null if no such property exists.]]> |
| </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, it sets the <code>value</code> to the keys |
| that replace the deprecated key. |
| |
| @param name property name. |
| @param value property value.]]> |
| </doc> |
| </method> |
| <method name="setIfUnset" |
| 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[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. |
| @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, or if the specified value is not a valid |
| <code>int</code>, then <code>defaultValue</code> is returned. |
| |
| @param name property name. |
| @param defaultValue default value. |
| @return property value as an <code>int</code>, |
| or <code>defaultValue</code>.]]> |
| </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 is specified, or if the specified value is not a valid |
| <code>long</code>, then <code>defaultValue</code> is returned. |
| |
| @param name property name. |
| @param defaultValue default value. |
| @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 is specified, or if the specified value is not a valid |
| <code>float</code>, then <code>defaultValue</code> is returned. |
| |
| @param name property name. |
| @param defaultValue default value. |
| @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="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(<name>, 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. |
| @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="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. |
| |
| @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="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="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="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="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}. |
| |
| @param out the output stream to write to.]]> |
| </doc> |
| </method> |
| <method name="writeXml" |
| abstract="false" native="false" synchronized="true" |
| 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> |
| <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}/../core-default.html">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> |
| <property> |
| <name>dfs.client.buffer.dir</name> |
| <value>/tmp/hadoop/dfs/client</value> |
| <b><final>true</final></b> |
| </property></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> |
| <property> |
| <name>basedir</name> |
| <value>/user/${<i>user.name</i>}</value> |
| </property> |
| |
| <property> |
| <name>tempdir</name> |
| <value>${<i>basedir</i>}/tmp</value> |
| </property></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.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.conf.Configuration --> |
| <!-- start class org.apache.hadoop.conf.Configuration.IntegerRanges --> |
| <class name="Configuration.IntegerRanges" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Configuration.IntegerRanges" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="Configuration.IntegerRanges" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="isIncluded" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="int"/> |
| <doc> |
| <![CDATA[Is the given value in the set of ranges |
| @param value the value to check |
| @return is the value in the ranges?]]> |
| </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> |
| <doc> |
| <![CDATA[A class that represents a set of positive integer ranges. It parses |
| strings of the form: "2-3,5,7-" where ranges are separated by comma and |
| the lower/upper bounds are separated by dash. Either the lower or upper |
| bound may be omitted meaning all values up to or over. So the string |
| above means 2, 3, 5, and 7, 8, 9, ...]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.conf.Configuration.IntegerRanges --> |
| <!-- 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.ConfServlet.BadFormatException --> |
| <class name="ConfServlet.BadFormatException" extends="java.lang.Exception" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ConfServlet.BadFormatException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| </class> |
| <!-- end class org.apache.hadoop.conf.ConfServlet.BadFormatException --> |
| <doc> |
| <![CDATA[Configuration of system parameters.]]> |
| </doc> |
| </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="protected" |
| 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="protected" |
| deprecated="not deprecated"> |
| </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="scheme" type="java.lang.String"/> |
| <param name="cls" type="java.lang.Class"/> |
| <doc> |
| <![CDATA[Get the statistics for a particular file system. |
| @param cls the class to lookup |
| @return a statistics object]]> |
| </doc> |
| </method> |
| <method name="clearStatistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </method> |
| <method name="printStatistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </method> |
| <method name="checkScheme" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="supportedScheme" type="java.lang.String"/> |
| </method> |
| <method name="getUriDefaultPort" return="int" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="protected" |
| 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="protected" |
| 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="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="true" visibility="protected" |
| 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="protected" |
| 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="bytesPerChecksum" type="int"/> |
| <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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="setReplication" return="boolean" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns true if the file system supports symlinks, false otherwise.]]> |
| </doc> |
| </method> |
| <method name="createSymlink" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getLinkTarget(Path)};]]> |
| </doc> |
| </method> |
| <method name="setPermission" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="protected" |
| 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="java.util.Iterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="listStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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="setVerifyChecksum" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| 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> |
| <field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics" |
| transient="false" volatile="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The statistics for this file system.]]> |
| </doc> |
| </field> |
| <doc> |
| <![CDATA[This class provides an interface for implementors of a Hadoop file system |
| (analogous to the VFS of Unix). Applications do not access this class; |
| instead they access files across all file systems using {@link FileContext}. |
| |
| Pathnames passed to AbstractFileSystem can be fully qualified URI that |
| matches the "this" file system (ie same scheme and authority) |
| or a Slash-relative name that is assumed to be relative |
| to the root of the "this" file system .]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.AbstractFileSystem --> |
| <!-- start class org.apache.hadoop.fs.AvroFSInput --> |
| <class name="AvroFSInput" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.io.Closeable"/> |
| <implements name="org.apache.avro.file.SeekableInput"/> |
| <constructor name="AvroFSInput" type="org.apache.hadoop.fs.FSDataInputStream, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct given an {@link FSDataInputStream} and its length.]]> |
| </doc> |
| </constructor> |
| <constructor name="AvroFSInput" type="org.apache.hadoop.fs.FileContext, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct given a {@link FileContext} and a {@link Path}.]]> |
| </doc> |
| </constructor> |
| <method name="length" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="read" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b" type="byte[]"/> |
| <param name="off" type="int"/> |
| <param name="len" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="seek" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="tell" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </method> |
| <doc> |
| <![CDATA[Adapts an {@link FSDataInputStream} to Avro's SeekableInput interface.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.AvroFSInput --> |
| <!-- start class org.apache.hadoop.fs.BlockLocation --> |
| <class name="BlockLocation" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="BlockLocation" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default Constructor]]> |
| </doc> |
| </constructor> |
| <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor with host, name, offset and length]]> |
| </doc> |
| </constructor> |
| <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor with host, name, network topology, offset and length]]> |
| </doc> |
| </constructor> |
| <method name="getHosts" return="java.lang.String[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the list of hosts (hostname) hosting this block]]> |
| </doc> |
| </method> |
| <method name="getNames" return="java.lang.String[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the list of names (hostname:port) hosting this block]]> |
| </doc> |
| </method> |
| <method name="getTopologyPaths" return="java.lang.String[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the list of network topology paths for each of the hosts. |
| The last component of the path is the host.]]> |
| </doc> |
| </method> |
| <method name="getOffset" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the start offset of file associated with this block]]> |
| </doc> |
| </method> |
| <method name="getLength" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the length of the block]]> |
| </doc> |
| </method> |
| <method name="setOffset" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="offset" type="long"/> |
| <doc> |
| <![CDATA[Set the start offset of file associated with this block]]> |
| </doc> |
| </method> |
| <method name="setLength" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="length" type="long"/> |
| <doc> |
| <![CDATA[Set the length of block]]> |
| </doc> |
| </method> |
| <method name="setHosts" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="hosts" type="java.lang.String[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set the hosts hosting this block]]> |
| </doc> |
| </method> |
| <method name="setNames" |
| 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[Set the names (host:port) hosting this block]]> |
| </doc> |
| </method> |
| <method name="setTopologyPaths" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="topologyPaths" type="java.lang.String[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set the network topology paths of the hosts]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[Implement write of Writable]]> |
| </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"/> |
| <doc> |
| <![CDATA[Implement readFields of Writable]]> |
| </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> |
| </class> |
| <!-- end class org.apache.hadoop.fs.BlockLocation --> |
| <!-- start class org.apache.hadoop.fs.ChecksumException --> |
| <class name="ChecksumException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ChecksumException" type="java.lang.String, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getPos" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <doc> |
| <![CDATA[Thrown for checksum errors.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ChecksumException --> |
| <!-- start class org.apache.hadoop.fs.ChecksumFileSystem --> |
| <class name="ChecksumFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ChecksumFileSystem" type="org.apache.hadoop.fs.FileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getApproxChkSumLength" return="double" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="size" type="long"/> |
| </method> |
| <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="setVerifyChecksum" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="verifyChecksum" type="boolean"/> |
| <doc> |
| <![CDATA[Set whether to verify checksum.]]> |
| </doc> |
| </method> |
| <method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[get the raw file system]]> |
| </doc> |
| </method> |
| <method name="getChecksumFile" return="org.apache.hadoop.fs.Path" |
| 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[Return the name of the checksum file associated with a file.]]> |
| </doc> |
| </method> |
| <method name="isChecksumFile" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Return true iff file is a checksum file name.]]> |
| </doc> |
| </method> |
| <method name="getChecksumFileLength" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.Path"/> |
| <param name="fileSize" type="long"/> |
| <doc> |
| <![CDATA[Return the length of the checksum file given the size of the |
| actual file.]]> |
| </doc> |
| </method> |
| <method name="getBytesPerSum" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the bytes Per Checksum]]> |
| </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"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataInputStream at the indicated Path. |
| @param f the file name to open |
| @param bufferSize the size of the buffer to be used.]]> |
| </doc> |
| </method> |
| <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream" |
| 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="bufferSize" type="int"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="getChecksumLength" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="size" type="long"/> |
| <param name="bytesPerSum" type="int"/> |
| <doc> |
| <![CDATA[Calculated the length of the checksum file in bytes. |
| @param size the length of the data file in bytes |
| @param bytesPerSum the number of bytes in a checksum block |
| @return the number of bytes in the checksum file]]> |
| </doc> |
| </method> |
| <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| 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="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="overwrite" type="boolean"/> |
| <param name="bufferSize" type="int"/> |
| <param name="replication" type="short"/> |
| <param name="blockSize" type="long"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="setReplication" return="boolean" |
| 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="replication" type="short"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set replication for an existing file. |
| Implement the abstract <tt>setReplication</tt> of <tt>FileSystem</tt> |
| @param src file name |
| @param replication new replication |
| @throws IOException |
| @return true if successful; |
| false if file does not exist or is a directory]]> |
| </doc> |
| </method> |
| <method name="rename" return="boolean" |
| 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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Rename files/dirs]]> |
| </doc> |
| </method> |
| <method name="delete" 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="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Implement the delete(Path, boolean) in checksum |
| file system.]]> |
| </doc> |
| </method> |
| <method name="listStatus" 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="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[List the statuses of the files/directories in the given path if the path is |
| a directory. |
| |
| @param f |
| given path |
| @return the statuses of the files/directories in the given patch |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="mkdirs" 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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="copyFromLocalFile" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="delSrc" type="boolean"/> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="copyToLocalFile" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="delSrc" type="boolean"/> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The src file is under FS, and the dst is on the local disk. |
| Copy it from FS control to the local dst name.]]> |
| </doc> |
| </method> |
| <method name="copyToLocalFile" |
| 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="copyCrc" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The src file is under FS, and the dst is on the local disk. |
| Copy it from FS control to the local dst name. |
| If src and dst are directories, the copyCrc parameter |
| determines whether to copy CRC files.]]> |
| </doc> |
| </method> |
| <method name="startLocalOutput" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/> |
| <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="completeLocalOutput" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/> |
| <param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="reportChecksumFailure" 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="in" type="org.apache.hadoop.fs.FSDataInputStream"/> |
| <param name="inPos" type="long"/> |
| <param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/> |
| <param name="sumsPos" type="long"/> |
| <doc> |
| <![CDATA[Report a checksum error to the file system. |
| @param f the file name containing the error |
| @param in the stream open on the file |
| @param inPos the position of the beginning of the bad data in the file |
| @param sums the stream open on the checksum file |
| @param sumsPos the position of the beginning of the bad data in the checksum file |
| @return if retry is neccessary]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Abstract Checksumed FileSystem. |
| It provide a basice implementation of a Checksumed FileSystem, |
| which creates a checksum file for each raw file. |
| It generates & verifies checksums at the client side.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ChecksumFileSystem --> |
| <!-- start class org.apache.hadoop.fs.ContentSummary --> |
| <class name="ContentSummary" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="ContentSummary" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor]]> |
| </doc> |
| </constructor> |
| <constructor name="ContentSummary" type="long, long, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor]]> |
| </doc> |
| </constructor> |
| <constructor name="ContentSummary" type="long, long, long, long, long, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor]]> |
| </doc> |
| </constructor> |
| <method name="getLength" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[@return the length]]> |
| </doc> |
| </method> |
| <method name="getDirectoryCount" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[@return the directory count]]> |
| </doc> |
| </method> |
| <method name="getFileCount" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[@return the file count]]> |
| </doc> |
| </method> |
| <method name="getQuota" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the directory quota]]> |
| </doc> |
| </method> |
| <method name="getSpaceConsumed" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Retuns (disk) space consumed]]> |
| </doc> |
| </method> |
| <method name="getSpaceQuota" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns (disk) space quota]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </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"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="getHeader" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="qOption" type="boolean"/> |
| <doc> |
| <![CDATA[Return the header of the output. |
| if qOption is false, output directory count, file count, and content size; |
| if qOption is true, output quota and remaining quota as well. |
| |
| @param qOption a flag indicating if quota needs to be printed or not |
| @return the header of the output]]> |
| </doc> |
| </method> |
| <method name="toString" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="toString" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="qOption" type="boolean"/> |
| <doc> |
| <![CDATA[Return the string representation of the object in the output format. |
| if qOption is false, output directory count, file count, and content size; |
| if qOption is true, output quota and remaining quota as well. |
| |
| @param qOption a flag indicating if quota needs to be printed or not |
| @return the string representation of the object]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Store the summary of a content (a directory or a file).]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ContentSummary --> |
| <!-- start class org.apache.hadoop.fs.CreateFlag --> |
| <class name="CreateFlag" extends="java.lang.Enum" |
| abstract="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <method name="values" return="org.apache.hadoop.fs.CreateFlag[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="valueOf" return="org.apache.hadoop.fs.CreateFlag" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="name" type="java.lang.String"/> |
| </method> |
| <doc> |
| <![CDATA[CreateFlag specifies the file create semantic. Users can combine flags like:<br> |
| <code> |
| EnumSet.of(CreateFlag.CREATE, CreateFlag.APPEND) |
| <code> |
| and pass it to {@link org.apache.hadoop.fs.FileSystem #create(Path f, FsPermission permission, |
| EnumSet<CreateFlag> flag, int bufferSize, short replication, long blockSize, |
| Progressable progress)}. |
| |
| <p> |
| Combine {@link #OVERWRITE} with either {@link #CREATE} |
| or {@link #APPEND} does the same as only use |
| {@link #OVERWRITE}. <br> |
| Combine {@link #CREATE} with {@link #APPEND} has the semantic: |
| <ol> |
| <li> create the file if it does not exist; |
| <li> append the file if it already exists. |
| </ol>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.CreateFlag --> |
| <!-- start class org.apache.hadoop.fs.FileAlreadyExistsException --> |
| <class name="FileAlreadyExistsException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FileAlreadyExistsException" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FileAlreadyExistsException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Used when target file already exists for any operation and |
| is not configured to be overwritten.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileAlreadyExistsException --> |
| <!-- start class org.apache.hadoop.fs.FileChecksum --> |
| <class name="FileChecksum" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="FileChecksum" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getAlgorithmName" return="java.lang.String" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The checksum algorithm name]]> |
| </doc> |
| </method> |
| <method name="getLength" return="int" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The length of the checksum in bytes]]> |
| </doc> |
| </method> |
| <method name="getBytes" return="byte[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The value of the checksum in bytes]]> |
| </doc> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="other" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Return true if both the algorithms and the values are the same.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[An abstract class representing file checksums for files.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileChecksum --> |
| <!-- start class org.apache.hadoop.fs.FileContext --> |
| <class name="FileContext" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="defFS" type="org.apache.hadoop.fs.AbstractFileSystem"/> |
| <param name="aConf" type="org.apache.hadoop.conf.Configuration"/> |
| <doc> |
| <![CDATA[Create a FileContext with specified FS as default using the specified |
| config. |
| |
| @param defFS |
| @param aConf |
| @return new FileContext with specifed FS as default.]]> |
| </doc> |
| </method> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="defaultFS" type="org.apache.hadoop.fs.AbstractFileSystem"/> |
| <doc> |
| <![CDATA[Create a FileContext for specified file system using the default config. |
| |
| @param defaultFS |
| @return a FileContext with the specified AbstractFileSystem |
| as the default FS.]]> |
| </doc> |
| </method> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[Create a FileContext using the default config read from the |
| $HADOOP_CONFIG/core.xml, Unspecified key-values for config are defaulted |
| from core-defaults.xml in the release jar. |
| |
| @throws UnsupportedFileSystemException If the file system from the default |
| configuration is not supported]]> |
| </doc> |
| </method> |
| <method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[@return a FileContext for the local file system using the default config. |
| @throws UnsupportedFileSystemException If the file system for |
| {@link FsConstants#LOCAL_FS_URI} is not supported.]]> |
| </doc> |
| </method> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="defaultFsUri" type="java.net.URI"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[Create a FileContext for specified URI using the default config. |
| |
| @param defaultFsUri |
| @return a FileContext with the specified URI as the default FS. |
| |
| @throws UnsupportedFileSystemException If the file system for |
| <code>defaultFsUri</code> is not supported]]> |
| </doc> |
| </method> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="defaultFsUri" type="java.net.URI"/> |
| <param name="aConf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[Create a FileContext for specified default URI using the specified config. |
| |
| @param defaultFsUri |
| @param aConf |
| @return new FileContext for specified uri |
| @throws UnsupportedFileSystemException If the file system with specified is |
| not supported]]> |
| </doc> |
| </method> |
| <method name="getFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="aConf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[Create a FileContext using the passed config. Generally it is better to use |
| {@link #getFileContext(URI, Configuration)} instead of this one. |
| |
| |
| @param aConf |
| @return new FileContext |
| @throws UnsupportedFileSystemException If file system in the config |
| is not supported]]> |
| </doc> |
| </method> |
| <method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="aConf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[@param aConf - from which the FileContext is configured |
| @return a FileContext for the local file system using the specified config. |
| |
| @throws UnsupportedFileSystemException If default file system in the config |
| is not supported]]> |
| </doc> |
| </method> |
| <method name="getDefaultFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newWDir" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set the working directory for wd-relative names (such a "foo/bar"). |
| @param newWDir |
| @throws IOException |
| |
| newWdir can be one of |
| - relative path: "foo/bar"; |
| - absolute without scheme: "/foo/bar" |
| - fully qualified with scheme: "xx://auth/foo/bar" |
| Illegal WDs: |
| - relative with scheme: "xx:foo/bar"]]> |
| </doc> |
| </method> |
| <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Gets the working directory for wd-relative names (such a "foo/bar").]]> |
| </doc> |
| </method> |
| <method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[@return the umask of this FileContext]]> |
| </doc> |
| </method> |
| <method name="setUMask" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newUmask" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <doc> |
| <![CDATA[Set umask to the supplied parameter. |
| @param newUmask the new umask]]> |
| </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 if it is isn't. |
| A Fully-qualified path has scheme and authority specified and an absolute |
| path. |
| Use the default file system and working dir in this FileContext to qualify. |
| @param path |
| @return qualified path]]> |
| </doc> |
| </method> |
| <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| 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="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="IOException" type="java.io.IOException"/> |
| <doc> |
| <