| <?xml version="1.0" encoding="iso-8859-1" standalone="no"?> |
| <!-- Generated by the JDiff Javadoc doclet --> |
| <!-- (http://www.jdiff.org) --> |
| <!-- on Sun Dec 04 00:57:52 UTC 2011 --> |
| |
| <api |
| xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' |
| xsi:noNamespaceSchemaLocation='api.xsd' |
| name="hadoop-core 0.22.0" |
| jdversion="1.0.9"> |
| |
| <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/build/hadoop-common-0.22.0.jar:/x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/build/ivy/lib/Hadoop-Common/jdiff/jdiff-1.0.9.jar -classpath /x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/build/classes:/x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/conf:/home/jenkins/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar:/home/jenkins/.ivy2/cache/log4j/log4j/bundles/log4j-1.2.16.jar:/home/jenkins/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.4.jar:/home/jenkins/.ivy2/cache/commons-cli/commons-cli/jars/commons-cli-1.2.jar:/home/jenkins/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/home/jenkins/.ivy2/cache/net.java.dev.jets3t/jets3t/jars/jets3t-0.7.1.jar:/home/jenkins/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.1.jar:/home/jenkins/.ivy2/cache/commons-net/commons-net/jars/commons-net-1.4.1.jar:/home/jenkins/.ivy2/cache/oro/oro/jars/oro-2.0.8.jar:/home/jenkins/.ivy2/cache/net.sf.kosmosfs/kfs/jars/kfs-0.3.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.26.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.26.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/servlet-api/jars/servlet-api-2.5-20081211.jar:/home/jenkins/.ivy2/cache/tomcat/jasper-runtime/jars/jasper-runtime-5.5.12.jar:/home/jenkins/.ivy2/cache/tomcat/jasper-compiler/jars/jasper-compiler-5.5.12.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/jsp-2.1-jetty/jars/jsp-2.1-jetty-6.1.26.jar:/home/jenkins/.ivy2/cache/org.eclipse.jdt/core/jars/core-3.1.1.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/jsp-api-2.1-glassfish/jars/jsp-api-2.1-glassfish-2.1.v20091210.jar:/home/jenkins/.ivy2/cache/org.mortbay.jetty/jsp-2.1-glassfish/jars/jsp-2.1-glassfish-2.1.v20091210.jar:/home/jenkins/.ivy2/cache/org.eclipse.jdt.core.compiler/ecj/jars/ecj-3.5.1.jar:/home/jenkins/.ivy2/cache/ant/ant/jars/ant-1.6.5.jar:/home/jenkins/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/home/jenkins/.ivy2/cache/jdiff/jdiff/jars/jdiff-1.0.9.jar:/home/jenkins/.ivy2/cache/hsqldb/hsqldb/jars/hsqldb-1.8.0.10.jar:/home/jenkins/.ivy2/cache/commons-logging/commons-logging-api/jars/commons-logging-api-1.1.jar:/home/jenkins/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.6.1.jar:/home/jenkins/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.6.1.jar:/home/jenkins/.ivy2/cache/org.apache.avro/avro/jars/avro-1.5.3.jar:/home/jenkins/.ivy2/cache/org.codehaus.jackson/jackson-mapper-asl/jars/jackson-mapper-asl-1.7.3.jar:/home/jenkins/.ivy2/cache/org.codehaus.jackson/jackson-core-asl/jars/jackson-core-asl-1.7.3.jar:/home/jenkins/.ivy2/cache/com.thoughtworks.paranamer/paranamer/jars/paranamer-2.3.jar:/home/jenkins/.ivy2/cache/org.xerial.snappy/snappy-java/bundles/snappy-java-1.0.3.2.jar:/home/jenkins/.ivy2/cache/org.apache.avro/avro-compiler/jars/avro-compiler-1.5.3.jar:/home/jenkins/.ivy2/cache/commons-lang/commons-lang/jars/commons-lang-2.5.jar:/home/jenkins/.ivy2/cache/org.apache.velocity/velocity/jars/velocity-1.6.4.jar:/home/jenkins/.ivy2/cache/commons-collections/commons-collections/jars/commons-collections-3.2.1.jar:/home/jenkins/.ivy2/cache/org.apache.avro/avro-ipc/jars/avro-ipc-1.5.3.jar:/home/jenkins/.ivy2/cache/com.thoughtworks.paranamer/paranamer-ant/jars/paranamer-ant-2.3.jar:/home/jenkins/.ivy2/cache/com.thoughtworks.paranamer/paranamer-generator/jars/paranamer-generator-2.3.jar:/home/jenkins/.ivy2/cache/com.thoughtworks.qdox/qdox/jars/qdox-1.12.jar:/home/jenkins/.ivy2/cache/asm/asm/jars/asm-3.3.jar:/home/jenkins/.ivy2/cache/org.apache.ant/ant/jars/ant-1.7.1.jar:/home/jenkins/.ivy2/cache/org.apache.ant/ant-launcher/jars/ant-launcher-1.7.1.jar:/home/jenkins/.ivy2/cache/org.aspectj/aspectjrt/jars/aspectjrt-1.6.5.jar:/home/jenkins/.ivy2/cache/org.aspectj/aspectjtools/jars/aspectjtools-1.6.5.jar:/home/jenkins/.ivy2/cache/org.mockito/mockito-all/jars/mockito-all-1.8.5.jar:/home/jenkins/.ivy2/cache/com.jcraft/jsch/jars/jsch-0.1.42.jar:/home/jenkins/.ivy2/cache/com.google.guava/guava/jars/guava-r09.jar:/home/jenkins/tools/ant/latest/lib/ant-launcher.jar:/usr/share/java/xmlParserAPIs.jar:/usr/share/java/xercesImpl.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-resolver.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-bcel.jar:/home/jenkins/tools/ant/latest/lib/ant-jsch.jar:/home/jenkins/tools/ant/latest/lib/ant-jmf.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-oro.jar:/home/jenkins/tools/ant/latest/lib/ant-netrexx.jar:/home/jenkins/tools/ant/latest/lib/ant-testutil.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-xalan2.jar:/home/jenkins/tools/ant/latest/lib/ant-javamail.jar:/home/jenkins/tools/ant/latest/lib/ant.jar:/home/jenkins/tools/ant/latest/lib/ant-junit.jar:/home/jenkins/tools/ant/latest/lib/ant-swing.jar:/home/jenkins/tools/ant/latest/lib/ant-commons-net.jar:/home/jenkins/tools/ant/latest/lib/ant-jdepend.jar:/home/jenkins/tools/ant/latest/lib/ant-junit4.jar:/home/jenkins/tools/ant/latest/lib/ant-commons-logging.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-bsf.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-log4j.jar:/home/jenkins/tools/ant/latest/lib/ant-jai.jar:/home/jenkins/tools/ant/latest/lib/ant-apache-regexp.jar:/home/jenkins/tools/ant/latest/lib/ant-antlr.jar:/tmp/jdk1.6.0_29/lib/tools.jar -sourcepath /x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/src/java -apidir /x1/jenkins/jenkins-slave/workspace/Hadoop-22-Build/common/common/lib/jdiff -apiname hadoop-core 0.22.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="getTrimmed" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="name" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Get the value of the <code>name</code> property as a trimmed <code>String</code>, |
| <code>null</code> if no such property exists. |
| If the key is deprecated, it returns the value of |
| the first key which replaces the deprecated key and is not null |
| |
| Values are processed for <a href="#VariableExpansion">variable expansion</a> |
| before being returned. |
| |
| @param name the property name. |
| @return the value of the <code>name</code> or its replacing property, |
| or null if no such property exists.]]> |
| </doc> |
| </method> |
| <method name="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="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.Writer"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Write out the non-default properties in this configuration to the given |
| {@link Writer}. |
| |
| @param out the writer to write to.]]> |
| </doc> |
| </method> |
| <method name="dumpConfiguration" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="config" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="out" type="java.io.Writer"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Writes out all the parameters and their properties (final and resource) to |
| the given {@link Writer} |
| The format of the output would be |
| { "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2, |
| key2.isFinal,key2.resource}... ] } |
| It does not output the parameters of the configuration object which is |
| loaded from an input stream. |
| @param out the Writer to write to |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="getClassLoader" return="java.lang.ClassLoader" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the {@link ClassLoader} for this job. |
| |
| @return the correct class loader.]]> |
| </doc> |
| </method> |
| <method name="setClassLoader" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="classLoader" type="java.lang.ClassLoader"/> |
| <doc> |
| <![CDATA[Set the class loader that will be used to load the various objects. |
| |
| @param classLoader the new class loader.]]> |
| </doc> |
| </method> |
| <method name="toString" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setQuietMode" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="quietmode" type="boolean"/> |
| <doc> |
| <![CDATA[Set the quietness-mode. |
| |
| In the quiet-mode, error and informational messages might not be logged. |
| |
| @param quietmode <code>true</code> to set quiet-mode on, <code>false</code> |
| to turn it off.]]> |
| </doc> |
| </method> |
| <method name="main" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="args" type="java.lang.String[]"/> |
| <exception name="Exception" type="java.lang.Exception"/> |
| <doc> |
| <![CDATA[For debugging. List non-default properties to the terminal and exit.]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getValByRegex" return="java.util.Map" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="regex" type="java.lang.String"/> |
| <doc> |
| <![CDATA[get keys matching the the regex |
| @param regex |
| @return Map<String,String> with matching keys]]> |
| </doc> |
| </method> |
| <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="public" |
| deprecated="not deprecated"> |
| <exception name="URISyntaxException" type="java.net.URISyntaxException"/> |
| <doc> |
| <![CDATA[Constructor to be called by subclasses. |
| |
| @param uri for this file system. |
| @param supportedScheme the scheme supported by the implementor |
| @param authorityNeeded if true then theURI must have authority, if false |
| then the URI must have null authority. |
| |
| @throws URISyntaxException <code>uri</code> has syntax error]]> |
| </doc> |
| </constructor> |
| <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="createFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[Create a file system instance for the specified uri using the conf. The |
| conf is used to find the class name that implements the file system. The |
| conf is also passed to the file system for its configuration. |
| |
| @param uri URI of the file system |
| @param conf Configuration for the file system |
| |
| @return Returns the file system for the given URI |
| |
| @throws UnsupportedFileSystemException file system for <code>uri</code> is |
| not found]]> |
| </doc> |
| </method> |
| <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| 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="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="printStatistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="get" return="org.apache.hadoop.fs.AbstractFileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <doc> |
| <![CDATA[The main factory method for creating a file system. Get a file system for |
| the URI's scheme and authority. The scheme of the <code>uri</code> |
| determines a configuration property name, |
| <tt>fs.AbstractFileSystem.<i>scheme</i>.impl</tt> whose value names the |
| AbstractFileSystem class. |
| |
| The entire URI and conf is passed to the AbstractFileSystem factory method. |
| |
| @param uri for the file system to be created. |
| @param conf which is passed to the file system impl. |
| |
| @return file system for the given URI. |
| |
| @throws UnsupportedFileSystemException if the file system for |
| <code>uri</code> is not supported.]]> |
| </doc> |
| </method> |
| <method name="checkScheme" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="supportedScheme" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Check that the Uri's scheme matches |
| @param uri |
| @param supportedScheme]]> |
| </doc> |
| </method> |
| <method name="getUriDefaultPort" return="int" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The default port of this file system. |
| |
| @return default port of this file system's Uri scheme |
| A uri with a port of -1 => default port;]]> |
| </doc> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a URI whose scheme and authority identify this FileSystem. |
| |
| @return the uri of this file system.]]> |
| </doc> |
| </method> |
| <method name="checkPath" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Check that a Path belongs to this FileSystem. |
| |
| If the path is fully qualified URI, then its scheme and authority |
| matches that of this file system. Otherwise the path must be |
| slash-relative name. |
| |
| @throws InvalidPathException if the path is invalid]]> |
| </doc> |
| </method> |
| <method name="getUriPath" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Get the path-part of a pathname. Checks that URI matches this file system |
| and that the path-part is a valid name. |
| |
| @param p path |
| |
| @return path-part of the Path p]]> |
| </doc> |
| </method> |
| <method name="makeQualified" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Make the path fully qualified to this file system |
| @param path |
| @return the qualified path]]> |
| </doc> |
| </method> |
| <method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Some file systems like LocalFileSystem have an initial workingDir |
| that is used as the starting workingDir. For other file systems |
| like HDFS there is no built in notion of an initial workingDir. |
| |
| @return the initial workingDir if the file system has such a notion |
| otherwise return a null.]]> |
| </doc> |
| </method> |
| <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the current user's home directory in this file system. |
| The default implementation returns "/user/$USER/". |
| |
| @return current user's home directory.]]> |
| </doc> |
| </method> |
| <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a set of server default configuration values. |
| |
| @return server default configuration values |
| |
| @throws IOException an I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="createFlag" type="java.util.EnumSet"/> |
| <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except |
| that the Path f must be fully qualified and the permission is absolute |
| (i.e. umask has been applied).]]> |
| </doc> |
| </method> |
| <method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="flag" type="java.util.EnumSet"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="bufferSize" type="int"/> |
| <param name="replication" type="short"/> |
| <param name="blockSize" type="long"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <param name="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="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="createParent" type="boolean"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#mkdir(Path, FsPermission, boolean)} except that the Path |
| f must be fully qualified and the permission is absolute (i.e. |
| umask has been applied).]]> |
| </doc> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#delete(Path, boolean)} except that Path f must be for |
| this file system.]]> |
| </doc> |
| </method> |
| <method name="open" return="org.apache.hadoop.fs.FSDataInputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#open(Path)} except that Path f must be for this |
| file system.]]> |
| </doc> |
| </method> |
| <method name="open" return="org.apache.hadoop.fs.FSDataInputStream" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#open(Path, int)} except that Path f must be for this |
| file system.]]> |
| </doc> |
| </method> |
| <method name="setReplication" return="boolean" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="replication" type="short"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#setReplication(Path, short)} except that Path f must be |
| for this file system.]]> |
| </doc> |
| </method> |
| <method name="rename" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path |
| f must be for this file system.]]> |
| </doc> |
| </method> |
| <method name="renameInternal" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path |
| f must be for this file system and NO OVERWRITE is performed. |
| |
| File systems that do not have a built in overwrite need implement only this |
| method and can take advantage of the default impl of the other |
| {@link #renameInternal(Path, Path, boolean)}]]> |
| </doc> |
| </method> |
| <method name="renameInternal" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="overwrite" type="boolean"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#rename(Path, Path, Options.Rename...)} except that Path |
| f must be for this file system.]]> |
| </doc> |
| </method> |
| <method name="supportsSymlinks" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns true if the file system supports symlinks, false otherwise.]]> |
| </doc> |
| </method> |
| <method name="createSymlink" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="target" type="org.apache.hadoop.fs.Path"/> |
| <param name="link" type="org.apache.hadoop.fs.Path"/> |
| <param name="createParent" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#createSymlink(Path, Path, boolean)};]]> |
| </doc> |
| </method> |
| <method name="getLinkTarget" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[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="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#setPermission(Path, FsPermission)} except that Path f |
| must be for this file system.]]> |
| </doc> |
| </method> |
| <method name="setOwner" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="username" type="java.lang.String"/> |
| <param name="groupname" type="java.lang.String"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#setOwner(Path, String, String)} except that Path f must |
| be for this file system.]]> |
| </doc> |
| </method> |
| <method name="setTimes" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="mtime" type="long"/> |
| <param name="atime" type="long"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#setTimes(Path, long, long)} except that Path f must be |
| for this file system.]]> |
| </doc> |
| </method> |
| <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFileChecksum(Path)} except that Path f must be for |
| this file system.]]> |
| </doc> |
| </method> |
| <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFileStatus(Path)} |
| except that an UnresolvedLinkException may be thrown if a symlink is |
| encountered in the path.]]> |
| </doc> |
| </method> |
| <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFileLinkStatus(Path)} |
| except that an UnresolvedLinkException may be thrown if a symlink is |
| encountered in the path leading up to the final path component. |
| If the file system does not support symlinks then the behavior is |
| equivalent to {@link AbstractFileSystem#getFileStatus(Path)}.]]> |
| </doc> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="start" type="long"/> |
| <param name="len" type="long"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFileBlockLocations(Path, long, long)} except that |
| Path f must be for this file system.]]> |
| </doc> |
| </method> |
| <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFsStatus(Path)} except that Path f must be for this |
| file system.]]> |
| </doc> |
| </method> |
| <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#getFsStatus(Path)}.]]> |
| </doc> |
| </method> |
| <method name="listStatusIterator" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#listStatus(Path)} except that Path f must be for this |
| file system.]]> |
| </doc> |
| </method> |
| <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#listLocatedStatus(Path)} except that Path f |
| must be for this file system.]]> |
| </doc> |
| </method> |
| <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext.Util#listStatus(Path)} except that Path f must be |
| for this file system.]]> |
| </doc> |
| </method> |
| <method name="setVerifyChecksum" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="verifyChecksum" type="boolean"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[The specification of this method matches that of |
| {@link FileContext#setVerifyChecksum(boolean, Path)} except that Path f |
| must be for this file system.]]> |
| </doc> |
| </method> |
| <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[], long, long, boolean" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor with host, name, offset, length and corrupt flag]]> |
| </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> |
| <constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long, boolean" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor with host, name, network topology, offset, length |
| and corrupt flag]]> |
| </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="isCorrupt" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the corrupt flag.]]> |
| </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="setCorrupt" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="corrupt" type="boolean"/> |
| <doc> |
| <![CDATA[Set the corrupt flag.]]> |
| </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="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="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.CommonConfigurationKeysPublic --> |
| <class name="CommonConfigurationKeysPublic" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="CommonConfigurationKeysPublic" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <field name="IO_NATIVE_LIB_AVAILABLE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_NATIVE_LIB_AVAILABLE_DEFAULT" type="boolean" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_NATIVE_LIB_AVAILABLE_KEY]]> |
| </doc> |
| </field> |
| <field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for NET_TOPOLOGY_SCRIPT_NUMBER_ARGS_KEY]]> |
| </doc> |
| </field> |
| <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_DEFAULT_NAME_DEFAULT" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for FS_DEFAULT_NAME_KEY]]> |
| </doc> |
| </field> |
| <field name="FS_DF_INTERVAL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_DF_INTERVAL_DEFAULT" type="long" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for FS_DF_INTERVAL_KEY]]> |
| </doc> |
| </field> |
| <field name="NET_TOPOLOGY_SCRIPT_FILE_NAME_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="NET_TOPOLOGY_NODE_SWITCH_MAPPING_IMPL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_TRASH_CHECKPOINT_INTERVAL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_TRASH_CHECKPOINT_INTERVAL_DEFAULT" type="long" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for FS_TRASH_CHECKPOINT_INTERVAL_KEY]]> |
| </doc> |
| </field> |
| <field name="FS_LOCAL_BLOCK_SIZE_DEFAULT" type="long" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Not used anywhere, looks like default value for FS_LOCAL_BLOCK_SIZE]]> |
| </doc> |
| </field> |
| <field name="FS_AUTOMATIC_CLOSE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_AUTOMATIC_CLOSE_DEFAULT" type="boolean" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for FS_AUTOMATIC_CLOSE_KEY]]> |
| </doc> |
| </field> |
| <field name="FS_FILE_IMPL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_FTP_HOST_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_FTP_HOST_PORT_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_TRASH_INTERVAL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="FS_TRASH_INTERVAL_DEFAULT" type="long" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for FS_TRASH_INTERVAL_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_MAPFILE_BLOOM_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_MAPFILE_BLOOM_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_MAPFILE_BLOOM_SIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_MAPFILE_BLOOM_ERROR_RATE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_MAPFILE_BLOOM_ERROR_RATE_DEFAULT" type="float" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_MAPFILE_BLOOM_ERROR_RATE_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_COMPRESSION_CODEC_LZO_CLASS_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Codec class that implements Lzo compression algorithm]]> |
| </doc> |
| </field> |
| <field name="IO_MAP_INDEX_INTERVAL_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_MAP_INDEX_INTERVAL_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_MAP_INDEX_INTERVAL_DEFAULT]]> |
| </doc> |
| </field> |
| <field name="IO_MAP_INDEX_SKIP_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_MAP_INDEX_SKIP_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_MAP_INDEX_SKIP_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_SEQFILE_COMPRESS_BLOCKSIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_SEQFILE_COMPRESS_BLOCKSIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_FILE_BUFFER_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_FILE_BUFFER_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_FILE_BUFFER_SIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_SKIP_CHECKSUM_ERRORS_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IO_SKIP_CHECKSUM_ERRORS_DEFAULT" type="boolean" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_SKIP_CHECKSUM_ERRORS_KEY]]> |
| </doc> |
| </field> |
| <field name="IO_SORT_MB_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="Moved to mapreduce, see mapreduce.task.io.sort.mb |
| in mapred-default.xml |
| See https://issues.apache.org/jira/browse/HADOOP-6801"> |
| <doc> |
| <![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.mb |
| in mapred-default.xml |
| See https://issues.apache.org/jira/browse/HADOOP-6801]]> |
| </doc> |
| </field> |
| <field name="IO_SORT_MB_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_SORT_MB_DEFAULT]]> |
| </doc> |
| </field> |
| <field name="IO_SORT_FACTOR_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="Moved to mapreduce, see mapreduce.task.io.sort.factor |
| in mapred-default.xml |
| See https://issues.apache.org/jira/browse/HADOOP-6801"> |
| <doc> |
| <![CDATA[@deprecated Moved to mapreduce, see mapreduce.task.io.sort.factor |
| in mapred-default.xml |
| See https://issues.apache.org/jira/browse/HADOOP-6801]]> |
| </doc> |
| </field> |
| <field name="IO_SORT_FACTOR_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IO_SORT_FACTOR_DEFAULT]]> |
| </doc> |
| </field> |
| <field name="IO_SERIALIZATIONS_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="TFILE_IO_CHUNK_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="TFILE_IO_CHUNK_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for TFILE_IO_CHUNK_SIZE_DEFAULT]]> |
| </doc> |
| </field> |
| <field name="TFILE_FS_INPUT_BUFFER_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="TFILE_FS_INPUT_BUFFER_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for TFILE_FS_INPUT_BUFFER_SIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="TFILE_FS_OUTPUT_BUFFER_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="TFILE_FS_OUTPUT_BUFFER_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for TFILE_FS_OUTPUT_BUFFER_SIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_CONNECTION_MAXIDLETIME_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_CLIENT_CONNECTION_MAXIDLETIME_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_CONNECT_MAX_RETRIES_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_CLIENT_CONNECT_MAX_RETRIES_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_TCPNODELAY_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_TCPNODELAY_DEFAULT" type="boolean" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Defalt value for IPC_CLIENT_TCPNODELAY_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_SERVER_LISTEN_QUEUE_SIZE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_SERVER_LISTEN_QUEUE_SIZE_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_SERVER_LISTEN_QUEUE_SIZE_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_KILL_MAX_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_KILL_MAX_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_CLIENT_KILL_MAX_KEY]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_IDLETHRESHOLD_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_CLIENT_IDLETHRESHOLD_DEFAULT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_CLIENT_IDLETHRESHOLD_DEFAULT]]> |
| </doc> |
| </field> |
| <field name="IPC_SERVER_TCPNODELAY_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="IPC_SERVER_TCPNODELAY_DEFAULT" type="boolean" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for IPC_SERVER_TCPNODELAY_KEY]]> |
| </doc> |
| </field> |
| <field name="HADOOP_RPC_SOCKET_FACTORY_CLASS_DEFAULT_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SOCKS_SERVER_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_UTIL_HASH_TYPE_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_UTIL_HASH_TYPE_DEFAULT" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default value for HADOOP_UTIL_HASH_TYPE_KEY]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SECURITY_GROUP_MAPPING" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SECURITY_GROUPS_CACHE_SECS" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SECURITY_AUTHENTICATION" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SECURITY_AUTHORIZATION" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <field name="HADOOP_SECURITY_SERVICE_USER_NAME_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[See <a href="{@docRoot}/../core-default.html">core-default.xml</a>]]> |
| </doc> |
| </field> |
| <doc> |
| <![CDATA[This class contains constants for configuration keys used |
| in the common code. |
| |
| It includes all publicly documented configuration keys. In general |
| this class should not be used directly (use CommonConfigurationKeys |
| instead)]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.CommonConfigurationKeysPublic --> |
| <!-- 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="public" |
| 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="public" |
| 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"). Working |
| directory feature is provided by simply prefixing relative names with the |
| working dir. Note this is different from Unix where the wd is actually set |
| to the inode. Hence setWorkingDir does not follow symlinks etc. This works |
| better in a distributed environment that has multiple independent roots. |
| {@link #getWorkingDirectory()} should return what setWorkingDir() set. |
| |
| @param newWDir new working directory |
| @throws IOException |
| <br> |
| NewWdir can be one of: |
| <ul> |
| <li>relative path: "foo/bar";</li> |
| <li>absolute without scheme: "/foo/bar"</li> |
| <li>fully qualified with scheme: "xx://auth/foo/bar"</li> |
| </ul> |
| <br> |
| Illegal WDs: |
| <ul> |
| <li>relative with scheme: "xx:foo/bar"</li> |
| <li>non existent directory</li> |
| </ul>]]> |
| </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> |
| <![CDATA[Create or overwrite file on indicated path and returns an output stream for |
| writing into the file. |
| |
| @param f the file name to open |
| @param createFlag gives the semantics of create: overwrite, append etc. |
| @param opts file creation options; see {@link Options.CreateOpts}. |
| <ul> |
| <li>Progress - to report progress on the operation - default null |
| <li>Permission - umask is applied against permisssion: default is |
| FsPermissions:getDefault() |
| |
| <li>CreateParent - create missing parent path; default is to not |
| to create parents |
| <li>The defaults for the following are SS defaults of the file |
| server implementing the target path. Not all parameters make sense |
| for all kinds of file system - eg. localFS ignores Blocksize, |
| replication, checksum |
| <ul> |
| <li>BufferSize - buffersize used in FSDataOutputStream |
| <li>Blocksize - block size for file blocks |
| <li>ReplicationFactor - replication for blocks |
| <li>BytesPerChecksum - bytes per checksum |
| </ul> |
| </ul> |
| |
| @return {@link FSDataOutputStream} for created file |
| |
| @throws AccessControlException If access is denied |
| @throws FileAlreadyExistsException If file <code>f</code> already exists |
| @throws FileNotFoundException If parent of <code>f</code> does not exist |
| and <code>createParent</code> is false |
| @throws ParentNotDirectoryException If parent of <code>f</code> is not a |
| directory. |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws InvalidPathException If path <code>f</code> is not valid]]> |
| </doc> |
| </method> |
| <method name="mkdir" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="createParent" type="boolean"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Make(create) a directory and all the non-existent parents. |
| |
| @param dir - the dir to make |
| @param permission - permissions is set permission&~umask |
| @param createParent - if true then missing parent dirs are created if false |
| then parent must exist |
| |
| @throws AccessControlException If access is denied |
| @throws FileAlreadyExistsException If directory <code>dir</code> already |
| exists |
| @throws FileNotFoundException If parent of <code>dir</code> does not exist |
| and <code>createParent</code> is false |
| @throws ParentNotDirectoryException If parent of <code>dir</code> is not a |
| directory |
| @throws UnsupportedFileSystemException If file system for <code>dir</code> |
| is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws InvalidPathException If path <code>dir</code> is not valid]]> |
| </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="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[Delete a file. |
| @param f the path to delete. |
| @param recursive if path is a directory and set to |
| true, the directory is deleted else throws an exception. In |
| case of a file the recursive can be set to either true or false. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws InvalidPathException If path <code>f</code> is invalid]]> |
| </doc> |
| </method> |
| <method name="open" return="org.apache.hadoop.fs.FSDataInputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataInputStream at the indicated Path using |
| default buffersize. |
| @param f the file name to open |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If file <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> |
| is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </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="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[Opens an FSDataInputStream at the indicated Path. |
| |
| @param f the file name to open |
| @param bufferSize the size of the buffer to be used. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If file <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="setReplication" 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="replication" type="short"/> |
| <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[Set replication for an existing file. |
| |
| @param f file name |
| @param replication new replication |
| |
| @return true if successful |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If file <code>f</code> does not exist |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="rename" |
| 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="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="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Renames Path src to Path dst |
| <ul> |
| <li |
| <li>Fails if src is a file and dst is a directory. |
| <li>Fails if src is a directory and dst is a file. |
| <li>Fails if the parent of dst does not exist or is a file. |
| </ul> |
| <p> |
| If OVERWRITE option is not passed as an argument, rename fails if the dst |
| already exists. |
| <p> |
| If OVERWRITE option is passed as an argument, rename overwrites the dst if |
| it is a file or an empty directory. Rename fails if dst is a non-empty |
| directory. |
| <p> |
| Note that atomicity of rename is dependent on the file system |
| implementation. Please refer to the file system documentation for details |
| <p> |
| |
| @param src path to be renamed |
| @param dst new path after rename |
| |
| @throws AccessControlException If access is denied |
| @throws FileAlreadyExistsException If <code>dst</code> already exists and |
| <code>options</options> has {@link Rename#OVERWRITE} option |
| false. |
| @throws FileNotFoundException If <code>src</code> does not exist |
| @throws ParentNotDirectoryException If parent of <code>dst</code> is not a |
| directory |
| @throws UnsupportedFileSystemException If file system for <code>src</code> |
| and <code>dst</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="setPermission" |
| 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"/> |
| <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[Set permission of a path. |
| @param f |
| @param permission - the new absolute permission (umask is not applied) |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> |
| is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="setOwner" |
| 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="username" type="java.lang.String"/> |
| <param name="groupname" type="java.lang.String"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set owner of a path (i.e. a file or a directory). The parameters username |
| and groupname cannot both be null. |
| |
| @param f The path |
| @param username If it is null, the original username remains unchanged. |
| @param groupname If it is null, the original groupname remains unchanged. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws HadoopIllegalArgumentException If <code>username</code> or |
| <code>groupname</code> is invalid.]]> |
| </doc> |
| </method> |
| <method name="setTimes" |
| 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="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="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set access time of a file. |
| @param f The path |
| @param mtime Set the modification time of this file. |
| The number of milliseconds since epoch (Jan 1, 1970). |
| A value of -1 means that this call should not set modification time. |
| @param atime Set the access time of this file. |
| The number of milliseconds since Jan 1, 1970. |
| A value of -1 means that this call should not set access time. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the checksum of a file. |
| |
| @param f file path |
| |
| @return The file checksum. The default return value is null, |
| which indicates that no checksum algorithm is implemented |
| in the corresponding FileSystem. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="setVerifyChecksum" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="verifyChecksum" type="boolean"/> |
| <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[Set the verify checksum flag for the file system denoted by the path. |
| This is only applicable if the |
| corresponding FileSystem supports checksum. By default doesn't do anything. |
| @param verifyChecksum |
| @param f set the verifyChecksum for the Filesystem containing this path |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a file status object that represents the path. |
| @param f The path we want information from |
| |
| @return a FileStatus object |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a file status object that represents the path. If the path |
| refers to a symlink then the FileStatus of the symlink is returned. |
| The behavior is equivalent to #getFileStatus() if the underlying |
| file system does not support symbolic links. |
| @param f The path we want information from. |
| @return A FileStatus object |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="getLinkTarget" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="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[Returns the target of the given symbolic link as it was specified |
| when the link was created. Links in the path leading up to the |
| final path component are resolved transparently. |
| |
| @param f the path to return the target of |
| @return The un-interpreted target of the symbolic link. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If path <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If the given path does not refer to a symlink |
| or an I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| 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="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="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return blockLocation of the given file for the given offset and len. |
| For a nonexistent file or regions, null will be returned. |
| |
| This call is most helpful with DFS, where it returns |
| hostnames of machines that contain the given file. |
| |
| @param f - get blocklocations of this file |
| @param start position (byte offset) |
| @param len (in bytes) |
| |
| @return block locations for given file at specified offset of len |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws InvalidPathException If path <code>f</code> is invalid]]> |
| </doc> |
| </method> |
| <method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns a status object describing the use and capacity of the |
| file system denoted by the Parh argument p. |
| If the file system has multiple partitions, the |
| use and capacity of the partition pointed to by the specified |
| path is reflected. |
| |
| @param f Path for which status should be obtained. null means the |
| root partition of the default file system. |
| |
| @return a FsStatus object |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="createSymlink" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="target" type="org.apache.hadoop.fs.Path"/> |
| <param name="link" type="org.apache.hadoop.fs.Path"/> |
| <param name="createParent" type="boolean"/> |
| <exception name="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> |
| <![CDATA[Creates a symbolic link to an existing file. An exception is thrown if |
| the symlink exits, the user does not have permission to create symlink, |
| or the underlying file system does not support symlinks. |
| |
| Symlink permissions are ignored, access to a symlink is determined by |
| the permissions of the symlink target. |
| |
| Symlinks in paths leading up to the final path component are resolved |
| transparently. If the final path component refers to a symlink some |
| functions operate on the symlink itself, these are: |
| - delete(f) and deleteOnExit(f) - Deletes the symlink. |
| - rename(src, dst) - If src refers to a symlink, the symlink is |
| renamed. If dst refers to a symlink, the symlink is over-written. |
| - getLinkTarget(f) - Returns the target of the symlink. |
| - getFileLinkStatus(f) - Returns a FileStatus object describing |
| the symlink. |
| Some functions, create() and mkdir(), expect the final path component |
| does not exist. If they are given a path that refers to a symlink that |
| does exist they behave as if the path referred to an existing file or |
| directory. All other functions fully resolve, ie follow, the symlink. |
| These are: open, setReplication, setOwner, setTimes, setWorkingDirectory, |
| setPermission, getFileChecksum, setVerifyChecksum, getFileBlockLocations, |
| getFsStatus, getFileStatus, exists, and listStatus. |
| |
| Symlink targets are stored as given to createSymlink, assuming the |
| underlying file system is capable of storing a fully qualified URI. |
| Dangling symlinks are permitted. FileContext supports four types of |
| symlink targets, and resolves them as follows |
| <pre> |
| Given a path referring to a symlink of form: |
| |
| <---X---> |
| fs://host/A/B/link |
| <-----Y-----> |
| |
| In this path X is the scheme and authority that identify the file system, |
| and Y is the path leading up to the final path component "link". If Y is |
| a symlink itself then let Y' be the target of Y and X' be the scheme and |
| authority of Y'. Symlink targets may: |
| |
| 1. Fully qualified URIs |
| |
| fs://hostX/A/B/file Resolved according to the target file system. |
| |
| 2. Partially qualified URIs (eg scheme but no host) |
| |
| fs:///A/B/file Resolved according to the target file sytem. Eg resolving |
| a symlink to hdfs:///A results in an exception because |
| HDFS URIs must be fully qualified, while a symlink to |
| file:///A will not since Hadoop's local file systems |
| require partially qualified URIs. |
| |
| 3. Relative paths |
| |
| path Resolves to [Y'][path]. Eg if Y resolves to hdfs://host/A and path |
| is "../B/file" then [Y'][path] is hdfs://host/B/file |
| |
| 4. Absolute paths |
| |
| path Resolves to [X'][path]. Eg if Y resolves hdfs://host/A/B and path |
| is "/file" then [X][path] is hdfs://host/file |
| </pre> |
| |
| @param target the target of the symbolic link |
| @param link the path to be created that points to target |
| @param createParent if true then missing parent dirs are created if |
| false then parent must exist |
| |
| |
| @throws AccessControlException If access is denied |
| @throws FileAlreadyExistsException If file <code>linkcode> already exists |
| @throws FileNotFoundException If <code>target</code> does not exist |
| @throws ParentNotDirectoryException If parent of <code>link</code> is not a |
| directory. |
| @throws UnsupportedFileSystemException If file system for |
| <code>target</code> or <code>link</code> is not supported |
| @throws IOException If an I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="listStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <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 is the path |
| |
| @return an iterator that traverses statuses of the files/directories |
| in the given path |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <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. |
| Return the file's status and block locations If the path is a file. |
| |
| If a returned status is a file, it contains the file's block locations. |
| |
| @param f is the path |
| |
| @return an iterator that traverses statuses of the files/directories |
| in the given path |
| If any IO exception (for example the input directory gets deleted while |
| listing is being executed), next() or hasNext() of the returned iterator |
| may throw a RuntimeException with the io exception as the cause. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="deleteOnExit" 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="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Mark a path to be deleted on JVM shutdown. |
| |
| @param f the existing path to delete. |
| |
| @return true if deleteOnExit is successful, otherwise false. |
| |
| @throws AccessControlException If access is denied |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="util" return="org.apache.hadoop.fs.FileContext.Util" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="resolve" 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[Resolves all symbolic links in the specified path. |
| Returns the new path object.]]> |
| </doc> |
| </method> |
| <method name="resolveIntermediate" 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[Resolves all symbolic links in the specified path leading up |
| to, but not including the final path component. |
| @param f path to resolve |
| @return the new path object.]]> |
| </doc> |
| </method> |
| <field name="LOG" type="org.apache.commons.logging.Log" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="DEFAULT_PERM" type="org.apache.hadoop.fs.permission.FsPermission" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[The FileContext class provides an interface to the application writer for |
| using the Hadoop file system. |
| It provides a set of methods for the usual operation: create, open, |
| list, etc |
| |
| <p> |
| <b> *** Path Names *** </b> |
| <p> |
| |
| The Hadoop file system supports a URI name space and URI names. |
| It offers a forest of file systems that can be referenced using fully |
| qualified URIs. |
| Two common Hadoop file systems implementations are |
| <ul> |
| <li> the local file system: file:///path |
| <li> the hdfs file system hdfs://nnAddress:nnPort/path |
| </ul> |
| |
| While URI names are very flexible, it requires knowing the name or address |
| of the server. For convenience one often wants to access the default system |
| in one's environment without knowing its name/address. This has an |
| additional benefit that it allows one to change one's default fs |
| (e.g. admin moves application from cluster1 to cluster2). |
| <p> |
| |
| To facilitate this, Hadoop supports a notion of a default file system. |
| The user can set his default file system, although this is |
| typically set up for you in your environment via your default config. |
| A default file system implies a default scheme and authority; slash-relative |
| names (such as /for/bar) are resolved relative to that default FS. |
| Similarly a user can also have working-directory-relative names (i.e. names |
| not starting with a slash). While the working directory is generally in the |
| same default FS, the wd can be in a different FS. |
| <p> |
| Hence Hadoop path names can be one of: |
| <ul> |
| <li> fully qualified URI: scheme://authority/path |
| <li> slash relative names: /path relative to the default file system |
| <li> wd-relative names: path relative to the working dir |
| </ul> |
| Relative paths with scheme (scheme:foo/bar) are illegal. |
| |
| <p> |
| <b>****The Role of the FileContext and configuration defaults****</b> |
| <p> |
| The FileContext provides file namespace context for resolving file names; |
| it also contains the umask for permissions, In that sense it is like the |
| per-process file-related state in Unix system. |
| These two properties |
| <ul> |
| <li> default file system i.e your slash) |
| <li> umask |
| </ul> |
| in general, are obtained from the default configuration file |
| in your environment, (@see {@link Configuration}). |
| |
| No other configuration parameters are obtained from the default config as |
| far as the file context layer is concerned. All file system instances |
| (i.e. deployments of file systems) have default properties; we call these |
| server side (SS) defaults. Operation like create allow one to select many |
| properties: either pass them in as explicit parameters or use |
| the SS properties. |
| <p> |
| The file system related SS defaults are |
| <ul> |
| <li> the home directory (default is "/user/userName") |
| <li> the initial wd (only for local fs) |
| <li> replication factor |
| <li> block size |
| <li> buffer size |
| <li> bytesPerChecksum (if used). |
| </ul> |
| |
| <p> |
| <b> *** Usage Model for the FileContext class *** </b> |
| <p> |
| Example 1: use the default config read from the $HADOOP_CONFIG/core.xml. |
| Unspecified values come from core-defaults.xml in the release jar. |
| <ul> |
| <li> myFContext = FileContext.getFileContext(); // uses the default config |
| // which has your default FS |
| <li> myFContext.create(path, ...); |
| <li> myFContext.setWorkingDir(path) |
| <li> myFContext.open (path, ...); |
| </ul> |
| Example 2: Get a FileContext with a specific URI as the default FS |
| <ul> |
| <li> myFContext = FileContext.getFileContext(URI) |
| <li> myFContext.create(path, ...); |
| ... |
| </ul> |
| Example 3: FileContext with local file system as the default |
| <ul> |
| <li> myFContext = FileContext.getLocalFSFileContext() |
| <li> myFContext.create(path, ...); |
| <li> ... |
| </ul> |
| Example 4: Use a specific config, ignoring $HADOOP_CONFIG |
| Generally you should not need use a config unless you are doing |
| <ul> |
| <li> configX = someConfigSomeOnePassedToYou. |
| <li> myFContext = getFileContext(configX); // configX is not changed, |
| // is passed down |
| <li> myFContext.create(path, ...); |
| <li>... |
| </ul>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileContext --> |
| <!-- start class org.apache.hadoop.fs.FileContext.FSLinkResolver --> |
| <class name="FileContext.FSLinkResolver" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <constructor name="FileContext.FSLinkResolver" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="next" return="T" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.AbstractFileSystem"/> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/> |
| <doc> |
| <![CDATA[Generic helper function overridden on instantiation to perform a |
| specific operation on the given file system using the given path |
| which may result in an UnresolvedLinkException. |
| @param fs AbstractFileSystem to perform the operation on. |
| @param p Path given the file system. |
| @return Generic type determined by the specific implementation. |
| @throws UnresolvedLinkException If symbolic link <code>path</code> could |
| not be resolved |
| @throws IOException an I/O error occured]]> |
| </doc> |
| </method> |
| <method name="resolve" return="T" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fc" type="org.apache.hadoop.fs.FileContext"/> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Performs the operation specified by the next function, calling it |
| repeatedly until all symlinks in the given path are resolved. |
| @param fc FileContext used to access file systems. |
| @param p The path to resolve symlinks in. |
| @return Generic type determined by the implementation of next. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Class used to perform an operation on and resolve symlinks in a |
| path. The operation may potentially span multiple file systems.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileContext.FSLinkResolver --> |
| <!-- start class org.apache.hadoop.fs.FileContext.Util --> |
| <class name="FileContext.Util" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FileContext.Util" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="exists" 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="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Does the file exist? |
| Note: Avoid using this method if you already have FileStatus in hand. |
| Instead reuse the FileStatus |
| @param f the file or dir to be checked |
| |
| @throws AccessControlException If access is denied |
| @throws IOException If an I/O error occurred |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the {@link ContentSummary} of path f. |
| @param f path |
| |
| @return the {@link ContentSummary} of path f. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for |
| <code>f</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </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="files" type="org.apache.hadoop.fs.Path[]"/> |
| <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[See {@link #listStatus(Path[], PathFilter)}]]> |
| </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"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <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[Filter files/directories in the given path using the user-supplied path |
| filter. |
| |
| @param f is the path name |
| @param filter is the user-supplied path filter |
| |
| @return an array of FileStatus objects for the files under the given path |
| after applying the filter |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for |
| <code>pathPattern</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </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="files" type="org.apache.hadoop.fs.Path[]"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <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[Filter files/directories in the given list of paths using user-supplied |
| path filter. |
| |
| @param files is a list of paths |
| @param filter is the filter |
| |
| @return a list of statuses for the files under the given paths after |
| applying the filter |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If a file in <code>files</code> does not |
| exist |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </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="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[List the statuses of the files/directories in the given path |
| if the path is a directory. |
| |
| @param f is the path |
| |
| @return an array that contains statuses of the files/directories |
| in the given path |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> is |
| not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="listFiles" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <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[List the statuses and block locations of the files in the given path. |
| |
| If the path is a directory, |
| if recursive is false, returns files in the directory; |
| if recursive is true, return files in the subtree rooted at the path. |
| The subtree is traversed in the depth-first order. |
| If the path is a file, return the file's status and block locations. |
| Files across symbolic links are also returned. |
| |
| @param f is the path |
| @param recursive if the subdirectories need to be traversed recursively |
| |
| @return an iterator that traverses statuses of the files |
| If any IO exception (for example a sub-directory gets deleted while |
| listing is being executed), next() or hasNext() of the returned iterator |
| may throw a RuntimeException with the IO exception as the cause. |
| |
| @throws AccessControlException If access is denied |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws UnsupportedFileSystemException If file system for <code>f</code> |
| is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="pathPattern" type="org.apache.hadoop.fs.Path"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[<p>Return all the files that match filePattern and are not checksum |
| files. Results are sorted by their names. |
| |
| <p> |
| A filename pattern is composed of <i>regular</i> characters and |
| <i>special pattern matching</i> characters, which are: |
| |
| <dl> |
| <dd> |
| <dl> |
| <p> |
| <dt> <tt> ? </tt> |
| <dd> Matches any single character. |
| |
| <p> |
| <dt> <tt> * </tt> |
| <dd> Matches zero or more characters. |
| |
| <p> |
| <dt> <tt> [<i>abc</i>] </tt> |
| <dd> Matches a single character from character set |
| <tt>{<i>a,b,c</i>}</tt>. |
| |
| <p> |
| <dt> <tt> [<i>a</i>-<i>b</i>] </tt> |
| <dd> Matches a single character from the character range |
| <tt>{<i>a...b</i>}</tt>. Note: character <tt><i>a</i></tt> must be |
| lexicographically less than or equal to character <tt><i>b</i></tt>. |
| |
| <p> |
| <dt> <tt> [^<i>a</i>] </tt> |
| <dd> Matches a single char that is not from character set or range |
| <tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur |
| immediately to the right of the opening bracket. |
| |
| <p> |
| <dt> <tt> \<i>c</i> </tt> |
| <dd> Removes (escapes) any special meaning of character <i>c</i>. |
| |
| <p> |
| <dt> <tt> {ab,cd} </tt> |
| <dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt> |
| |
| <p> |
| <dt> <tt> {ab,c{de,fh}} </tt> |
| <dd> Matches a string from string set <tt>{<i>ab, cde, cfh</i>}</tt> |
| |
| </dl> |
| </dd> |
| </dl> |
| |
| @param pathPattern a regular expression specifying a pth pattern |
| |
| @return an array of paths that match the path pattern |
| |
| @throws AccessControlException If access is denied |
| @throws UnsupportedFileSystemException If file system for |
| <code>pathPattern</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="pathPattern" type="org.apache.hadoop.fs.Path"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/> |
| <exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return an array of FileStatus objects whose path names match pathPattern |
| and is accepted by the user-supplied path filter. Results are sorted by |
| their path names. |
| Return null if pathPattern has no glob and the path does not exist. |
| Return an empty array if pathPattern has a glob and no path matches it. |
| |
| @param pathPattern regular expression specifying the path pattern |
| @param filter user-supplied path filter |
| |
| @return an array of FileStatus objects |
| |
| @throws AccessControlException If access is denied |
| @throws UnsupportedFileSystemException If file system for |
| <code>pathPattern</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server]]> |
| </doc> |
| </method> |
| <method name="copy" 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="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> |
| <![CDATA[Copy file from src to dest. See |
| {@link #copy(Path, Path, boolean, boolean)}]]> |
| </doc> |
| </method> |
| <method name="copy" 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"/> |
| <param name="deleteSource" type="boolean"/> |
| <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="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy from src to dst, optionally deleting src and overwriting dst. |
| @param src |
| @param dst |
| @param deleteSource - delete src if true |
| @param overwrite overwrite dst if true; throw IOException if dst exists |
| and overwrite is false. |
| |
| @return true if copy is successful |
| |
| @throws AccessControlException If access is denied |
| @throws FileAlreadyExistsException If <code>dst</code> already exists |
| @throws FileNotFoundException If <code>src</code> does not exist |
| @throws ParentNotDirectoryException If parent of <code>dst</code> is not |
| a directory |
| @throws UnsupportedFileSystemException If file system for |
| <code>src</code> or <code>dst</code> is not supported |
| @throws IOException If an I/O error occurred |
| |
| Exceptions applicable to file systems accessed over RPC: |
| @throws RpcClientException If an exception occurred in the RPC client |
| @throws RpcServerException If an exception occurred in the RPC server |
| @throws UnexpectedServerException If server implementation throws |
| undeclared exception to RPC server |
| |
| RuntimeExceptions: |
| @throws InvalidPathException If path <code>dst</code> is invalid]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Utility/library methods built over the basic FileContext methods. |
| Since this are library functions, the oprtation are not atomic |
| and some of them may partially complete if other threads are making |
| changes to the same part of the name space.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileContext.Util --> |
| <!-- start class org.apache.hadoop.fs.FileStatus --> |
| <class name="FileStatus" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <implements name="java.lang.Comparable"/> |
| <constructor name="FileStatus" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FileStatus" type="long, boolean, int, long, long, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor for file systems on which symbolic links are not supported]]> |
| </doc> |
| </constructor> |
| <constructor name="FileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getLen" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the length of this file, in bytes. |
| @return the length of this file, in bytes.]]> |
| </doc> |
| </method> |
| <method name="isFile" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Is this a file? |
| @return true if this is a file]]> |
| </doc> |
| </method> |
| <method name="isDirectory" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Is this a directory? |
| @return true if this is a directory]]> |
| </doc> |
| </method> |
| <method name="isDir" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use {@link FileStatus#isFile()}, |
| {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()} |
| instead."> |
| <doc> |
| <![CDATA[Old interface, instead use the explicit {@link FileStatus#isFile()}, |
| {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()} |
| @return true if this is a directory. |
| @deprecated Use {@link FileStatus#isFile()}, |
| {@link FileStatus#isDirectory()}, and {@link FileStatus#isSymlink()} |
| instead.]]> |
| </doc> |
| </method> |
| <method name="isSymlink" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Is this a symbolic link? |
| @return true if this is a symbolic link]]> |
| </doc> |
| </method> |
| <method name="getBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the block size of the file. |
| @return the number of bytes]]> |
| </doc> |
| </method> |
| <method name="getReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the replication factor of a file. |
| @return the replication factor of a file.]]> |
| </doc> |
| </method> |
| <method name="getModificationTime" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the modification time of the file. |
| @return the modification time of file in milliseconds since January 1, 1970 UTC.]]> |
| </doc> |
| </method> |
| <method name="getAccessTime" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the access time of the file. |
| @return the access time of file in milliseconds since January 1, 1970 UTC.]]> |
| </doc> |
| </method> |
| <method name="getPermission" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get FsPermission associated with the file. |
| @return permssion. If a filesystem does not have a notion of permissions |
| or if permissions could not be determined, then default |
| permissions equivalent of "rwxrwxrwx" is returned.]]> |
| </doc> |
| </method> |
| <method name="getOwner" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the owner of the file. |
| @return owner of the file. The string could be empty if there is no |
| notion of owner of a file in a filesystem or if it could not |
| be determined (rare).]]> |
| </doc> |
| </method> |
| <method name="getGroup" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the group associated with the file. |
| @return group for the file. The string could be empty if there is no |
| notion of group of a file in a filesystem or if it could not |
| be determined (rare).]]> |
| </doc> |
| </method> |
| <method name="getPath" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setPath" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| </method> |
| <method name="setPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <doc> |
| <![CDATA[Sets permission. |
| @param permission if permission is null, default value is set]]> |
| </doc> |
| </method> |
| <method name="setOwner" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="owner" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Sets owner. |
| @param owner if it is null, default value is set]]> |
| </doc> |
| </method> |
| <method name="setGroup" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="group" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Sets group. |
| @param group if it is null, default value is set]]> |
| </doc> |
| </method> |
| <method name="getSymlink" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@return The contents of the symbolic link.]]> |
| </doc> |
| </method> |
| <method name="setSymlink" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="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="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compare this object to another object |
| |
| @param o the object to be compared. |
| @return a negative integer, zero, or a positive integer as this object |
| is less than, equal to, or greater than the specified object. |
| |
| @throws ClassCastException if the specified object's is not of |
| type FileStatus]]> |
| </doc> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compare if this object is equal to another object |
| @param o the object to be compared. |
| @return true if two file status has the same path name; false if not.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a hash code value for the object, which is defined as |
| the hash code of the path name. |
| |
| @return a hash code value for the path name.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Interface that represents the client side information for a file.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileStatus --> |
| <!-- start class org.apache.hadoop.fs.FileSystem --> |
| <class name="FileSystem" extends="org.apache.hadoop.conf.Configured" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.io.Closeable"/> |
| <constructor name="FileSystem" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="get" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="user" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="InterruptedException" type="java.lang.InterruptedException"/> |
| <doc> |
| <![CDATA[Get a filesystem instance based on the uri, the passed |
| configuration and the user |
| @param uri |
| @param conf |
| @param user |
| @return the filesystem instance |
| @throws IOException |
| @throws InterruptedException]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns the configured filesystem implementation.]]> |
| </doc> |
| </method> |
| <method name="getDefaultUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <doc> |
| <![CDATA[Get the default filesystem URI from a configuration. |
| @param conf the configuration to access |
| @return the uri of the default filesystem]]> |
| </doc> |
| </method> |
| <method name="setDefaultUri" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="uri" type="java.net.URI"/> |
| <doc> |
| <![CDATA[Set the default filesystem URI in a configuration. |
| @param conf the configuration to alter |
| @param uri the new default filesystem uri]]> |
| </doc> |
| </method> |
| <method name="setDefaultUri" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="uri" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Set the default filesystem URI in a configuration. |
| @param conf the configuration to alter |
| @param uri the new default filesystem uri]]> |
| </doc> |
| </method> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="name" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Called after a new FileSystem instance is constructed. |
| @param name a uri whose authority section names the host, port, etc. |
| for this FileSystem |
| @param conf the configuration]]> |
| </doc> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]> |
| </doc> |
| </method> |
| <method name="getDefaultPort" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the default port for this file system. |
| @return the default port or 0 if there isn't one]]> |
| </doc> |
| </method> |
| <method name="getCanonicalServiceName" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get a canonical name for this file system. |
| @return a URI string that uniquely identifies this file system]]> |
| </doc> |
| </method> |
| <method name="getName" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="call #getUri() instead."> |
| <doc> |
| <![CDATA[@deprecated call #getUri() instead.]]> |
| </doc> |
| </method> |
| <method name="getNamed" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="call #get(URI,Configuration) instead."> |
| <param name="name" type="java.lang.String"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@deprecated call #get(URI,Configuration) instead.]]> |
| </doc> |
| </method> |
| <method name="getLocal" return="org.apache.hadoop.fs.LocalFileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the local file system. |
| @param conf the configuration to configure the file system with |
| @return a LocalFileSystem]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns the FileSystem for this URI's scheme and authority. The scheme |
| of the URI determines a configuration property name, |
| <tt>fs.<i>scheme</i>.class</tt> whose value names the FileSystem class. |
| The entire URI is passed to the FileSystem instance's initialize method.]]> |
| </doc> |
| </method> |
| <method name="newInstance" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="user" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="InterruptedException" type="java.lang.InterruptedException"/> |
| <doc> |
| <![CDATA[Returns the FileSystem for this URI's scheme and authority and the |
| passed user. Internally invokes {@link #newInstance(URI, Configuration)} |
| @param uri |
| @param conf |
| @param user |
| @return filesystem instance |
| @throws IOException |
| @throws InterruptedException]]> |
| </doc> |
| </method> |
| <method name="newInstance" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns the FileSystem for this URI's scheme and authority. The scheme |
| of the URI determines a configuration property name, |
| <tt>fs.<i>scheme</i>.class</tt> whose value names the FileSystem class. |
| The entire URI is passed to the FileSystem instance's initialize method. |
| This always returns a new FileSystem object.]]> |
| </doc> |
| </method> |
| <method name="newInstance" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns a unique configured filesystem implementation. |
| This always returns a new FileSystem object.]]> |
| </doc> |
| </method> |
| <method name="newInstanceLocal" return="org.apache.hadoop.fs.LocalFileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get a unique local file system object |
| @param conf the configuration to configure the file system with |
| @return a LocalFileSystem |
| This always returns a new FileSystem object.]]> |
| </doc> |
| </method> |
| <method name="closeAll" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Close all cached filesystems. Be sure those filesystems are not |
| used anymore. |
| |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="closeAllForUGI" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="ugi" type="org.apache.hadoop.security.UserGroupInformation"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Close all cached filesystems for a given UGI. Be sure those filesystems |
| are not used anymore. |
| @param ugi |
| @throws IOException]]> |
| </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 sure that a path specifies a FileSystem.]]> |
| </doc> |
| </method> |
| <method name="getDelegationToken" return="org.apache.hadoop.security.token.Token" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="renewer" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get a new delegation token for this file system. |
| @param renewer the account name that is allowed to renew the token. |
| @return a new delegation token |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="file" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[create a file with the provided permission |
| The permission of the file is set to be the provided permission as in |
| setPermission, not permission&~umask |
| |
| It is implemented using two RPCs. It is understood that it is inefficient, |
| but the implementation is thread-safe. The other option is to change the |
| value of umask in configuration to be 0, but it is not thread-safe. |
| |
| @param fs file system handle |
| @param file the name of the file to be created |
| @param permission the permission of the file |
| @return an output stream |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="mkdirs" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[create a directory with the provided permission |
| The permission of the directory is set to be the provided permission as in |
| setPermission, not permission&~umask |
| |
| @see #create(FileSystem, Path, FsPermission) |
| |
| @param fs file system handle |
| @param dir the name of the directory to be created |
| @param permission the permission of the directory |
| @return true if the directory creation succeeds; false otherwise |
| @throws IOException]]> |
| </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.]]> |
| </doc> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.FileStatus"/> |
| <param name="start" type="long"/> |
| <param name="len" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return an array containing hostnames, offset and size of |
| portions of the given file. For a nonexistent |
| file or regions, null will be returned. |
| |
| This call is most helpful with DFS, where it returns |
| hostnames of machines that contain the given file. |
| |
| The FileSystem will simply return an elt containing 'localhost'.]]> |
| </doc> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="start" type="long"/> |
| <param name="len" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return an array containing hostnames, offset and size of |
| portions of the given file. For a nonexistent |
| file or regions, null will be returned. |
| |
| This call is most helpful with DFS, where it returns |
| hostnames of machines that contain the given file. |
| |
| The FileSystem will simply return an elt containing 'localhost'.]]> |
| </doc> |
| </method> |
| <method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a set of server default configuration values |
| @return server default configuration values |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="open" return="org.apache.hadoop.fs.FSDataInputStream" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="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="open" return="org.apache.hadoop.fs.FSDataInputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataInputStream at the indicated Path. |
| @param f the file to open]]> |
| </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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path. |
| Files are overwritten by default.]]> |
| </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="overwrite" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated 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="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| Files are overwritten by default.]]> |
| </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="replication" type="short"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path. |
| Files are overwritten by default.]]> |
| </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="replication" type="short"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| Files are overwritten by default.]]> |
| </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="overwrite" type="boolean"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path. |
| @param f the file name to open |
| @param overwrite if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown. |
| @param bufferSize the size of the buffer to be used.]]> |
| </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="overwrite" type="boolean"/> |
| <param name="bufferSize" type="int"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| @param f the file name to open |
| @param overwrite if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown. |
| @param bufferSize the size of the buffer to be used.]]> |
| </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="overwrite" type="boolean"/> |
| <param name="bufferSize" type="int"/> |
| <param name="replication" type="short"/> |
| <param name="blockSize" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Opens an FSDataOutputStream at the indicated Path. |
| @param f the file name to open |
| @param overwrite if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown. |
| @param bufferSize the size of the buffer to be used. |
| @param replication required block replication for the 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="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[Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| @param f the file name to open |
| @param overwrite if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown. |
| @param bufferSize the size of the buffer to be used. |
| @param replication required block replication for the file.]]> |
| </doc> |
| </method> |
| <method name="create" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="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[Opens an FSDataOutputStream at the indicated Path with write-progress |
| reporting. |
| @param f the file name to open |
| @param permission |
| @param overwrite if a file with this name already exists, then if true, |
| the file will be overwritten, and if false an error will be thrown. |
| @param bufferSize the size of the buffer to be used. |
| @param replication required block replication for the file. |
| @param blockSize |
| @param progress |
| @throws IOException |
| @see #setPermission(Path, FsPermission)]]> |
| </doc> |
| </method> |
| <method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="flag" type="java.util.EnumSet"/> |
| <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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="primitiveMkdir" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[This version of the mkdirs method assumes that the permission is absolute. |
| It has been added to support the FileContext that processes the permission |
| with umask before calling this method. |
| This a temporary method added to support the transition from FileSystem |
| to FileContext for user applications.]]> |
| </doc> |
| </method> |
| <method name="primitiveMkdir" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="createParent" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[This version of the mkdirs method assumes that the permission is absolute. |
| It has been added to support the FileContext that processes the permission |
| with umask before calling this method. |
| This a temporary method added to support the transition from FileSystem |
| to FileContext for user applications.]]> |
| </doc> |
| </method> |
| <method name="createNewFile" 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"/> |
| <doc> |
| <![CDATA[Creates the given Path as a brand-new zero-length file. If |
| create fails, or if it already existed, return false.]]> |
| </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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Append to an existing file (optional operation). |
| Same as append(f, getConf().getInt("io.file.buffer.size", 4096), null) |
| @param f the existing file to be appended. |
| @throws IOException]]> |
| </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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Append to an existing file (optional operation). |
| Same as append(f, bufferSize, null). |
| @param f the existing file to be appended. |
| @param bufferSize the size of the buffer to be used. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="append" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <param name="progress" type="org.apache.hadoop.util.Progressable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Append to an existing file (optional operation). |
| @param f the existing file to be appended. |
| @param bufferSize the size of the buffer to be used. |
| @param progress for reporting progress if it is not null. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="getReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use getFileStatus() instead"> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get replication. |
| |
| @deprecated Use getFileStatus() instead |
| @param src file name |
| @return file replication |
| @throws IOException]]> |
| </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. |
| |
| @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="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Renames Path src to Path dst. Can take place on local fs |
| or remote DFS. |
| @throws IOException on failure |
| @return true if rename is successful]]> |
| </doc> |
| </method> |
| <method name="rename" |
| 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="options" type="org.apache.hadoop.fs.Options.Rename[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Renames Path src to Path dst |
| <ul> |
| <li |
| <li>Fails if src is a file and dst is a directory. |
| <li>Fails if src is a directory and dst is a file. |
| <li>Fails if the parent of dst does not exist or is a file. |
| </ul> |
| <p> |
| If OVERWRITE option is not passed as an argument, rename fails |
| if the dst already exists. |
| <p> |
| If OVERWRITE option is passed as an argument, rename overwrites |
| the dst if it is a file or an empty directory. Rename fails if dst is |
| a non-empty directory. |
| <p> |
| Note that atomicity of rename is dependent on the file system |
| implementation. Please refer to the file system documentation for |
| details. This default implementation is non atomic. |
| <p> |
| This method is deprecated since it is a temporary method added to |
| support the transition from FileSystem to FileContext for user |
| applications. |
| |
| @param src path to be renamed |
| @param dst new path after rename |
| @throws IOException on failure]]> |
| </doc> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use {@link #delete(Path, boolean)} instead."> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Delete a file |
| @deprecated Use {@link #delete(Path, boolean)} instead.]]> |
| </doc> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Delete a file. |
| |
| @param f the path to delete. |
| @param recursive if path is a directory and set to |
| true, the directory is deleted else throws an exception. In |
| case of a file the recursive can be set to either true or false. |
| @return true if delete is successful else false. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="deleteOnExit" 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"/> |
| <doc> |
| <![CDATA[Mark a path to be deleted when FileSystem is closed. |
| When the JVM shuts down, |
| all FileSystem objects will be closed automatically. |
| Then, |
| the marked path will be deleted as a result of closing the FileSystem. |
| |
| The path has to exist in the file system. |
| |
| @param f the path to delete. |
| @return true if deleteOnExit is successful, otherwise false. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="processDeleteOnExit" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Delete all files that were marked as delete-on-exit. This recursively |
| deletes all files in the specified paths.]]> |
| </doc> |
| </method> |
| <method name="exists" 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"/> |
| <doc> |
| <![CDATA[Check if exists. |
| @param f source file]]> |
| </doc> |
| </method> |
| <method name="isDirectory" 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"/> |
| <doc> |
| <![CDATA[True iff the named path is a directory. |
| Note: Avoid using this method. Instead reuse the FileStatus |
| returned by getFileStatus() or listStatus() methods.]]> |
| </doc> |
| </method> |
| <method name="isFile" 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"/> |
| <doc> |
| <![CDATA[True iff the named path is a regular file. |
| Note: Avoid using this method. Instead reuse the FileStatus |
| returned by getFileStatus() or listStatus() methods.]]> |
| </doc> |
| </method> |
| <method name="getLength" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use getFileStatus() instead"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@deprecated Use getFileStatus() instead]]> |
| </doc> |
| </method> |
| <method name="getContentSummary" return="org.apache.hadoop.fs.ContentSummary" |
| 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[Return the {@link ContentSummary} of a given {@link Path}.]]> |
| </doc> |
| </method> |
| <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <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 FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </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"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Filter files/directories in the given path using the user-supplied path |
| filter. |
| |
| @param f |
| a path name |
| @param filter |
| the user-supplied path filter |
| @return an array of FileStatus objects for the files under the given path |
| after applying the filter |
| @throws FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </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="files" type="org.apache.hadoop.fs.Path[]"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Filter files/directories in the given list of paths using default |
| path filter. |
| |
| @param files |
| a list of paths |
| @return a list of statuses for the files under the given paths after |
| applying the filter default Path filter |
| @throws FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </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="files" type="org.apache.hadoop.fs.Path[]"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Filter files/directories in the given list of paths using user-supplied |
| path filter. |
| |
| @param files |
| a list of paths |
| @param filter |
| the user-supplied path filter |
| @return a list of statuses for the files under the given paths after |
| applying the filter |
| @throws FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </doc> |
| </method> |
| <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="pathPattern" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[<p>Return all the files that match filePattern and are not checksum |
| files. Results are sorted by their names. |
| |
| <p> |
| A filename pattern is composed of <i>regular</i> characters and |
| <i>special pattern matching</i> characters, which are: |
| |
| <dl> |
| <dd> |
| <dl> |
| <p> |
| <dt> <tt> ? </tt> |
| <dd> Matches any single character. |
| |
| <p> |
| <dt> <tt> * </tt> |
| <dd> Matches zero or more characters. |
| |
| <p> |
| <dt> <tt> [<i>abc</i>] </tt> |
| <dd> Matches a single character from character set |
| <tt>{<i>a,b,c</i>}</tt>. |
| |
| <p> |
| <dt> <tt> [<i>a</i>-<i>b</i>] </tt> |
| <dd> Matches a single character from the character range |
| <tt>{<i>a...b</i>}</tt>. Note that character <tt><i>a</i></tt> must be |
| lexicographically less than or equal to character <tt><i>b</i></tt>. |
| |
| <p> |
| <dt> <tt> [^<i>a</i>] </tt> |
| <dd> Matches a single character that is not from character set or range |
| <tt>{<i>a</i>}</tt>. Note that the <tt>^</tt> character must occur |
| immediately to the right of the opening bracket. |
| |
| <p> |
| <dt> <tt> \<i>c</i> </tt> |
| <dd> Removes (escapes) any special meaning of character <i>c</i>. |
| |
| <p> |
| <dt> <tt> {ab,cd} </tt> |
| <dd> Matches a string from the string set <tt>{<i>ab, cd</i>} </tt> |
| |
| <p> |
| <dt> <tt> {ab,c{de,fh}} </tt> |
| <dd> Matches a string from the string set <tt>{<i>ab, cde, cfh</i>}</tt> |
| |
| </dl> |
| </dd> |
| </dl> |
| |
| @param pathPattern a regular expression specifying a pth pattern |
| |
| @return an array of paths that match the path pattern |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="globStatus" return="org.apache.hadoop.fs.FileStatus[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="pathPattern" type="org.apache.hadoop.fs.Path"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return an array of FileStatus objects whose path names match pathPattern |
| and is accepted by the user-supplied path filter. Results are sorted by |
| their path names. |
| Return null if pathPattern has no glob and the path does not exist. |
| Return an empty array if pathPattern has a glob and no path matches it. |
| |
| @param pathPattern |
| a regular expression specifying the path pattern |
| @param filter |
| a user-supplied path filter |
| @return an array of FileStatus objects |
| @throws IOException if any I/O error occurs when fetching file status]]> |
| </doc> |
| </method> |
| <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <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. |
| Return the file's status and block locations If the path is a file. |
| |
| If a returned status is a file, it contains the file's block locations. |
| |
| @param f is the path |
| |
| @return an iterator that traverses statuses of the files/directories |
| in the given path |
| |
| @throws FileNotFoundException If <code>f</code> does not exist |
| @throws IOException If an I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="filter" type="org.apache.hadoop.fs.PathFilter"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Listing a directory |
| The returned results include its block location if it is a file |
| The results are filtered by the given path filter |
| @param f a path |
| @param filter a path filter |
| @return an iterator that traverses statuses of the files/directories |
| in the given path |
| @throws FileNotFoundException if <code>f</code> does not exist |
| @throws IOException if any I/O error occurred]]> |
| </doc> |
| </method> |
| <method name="listFiles" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[List the statuses and block locations of the files in the given path. |
| |
| If the path is a directory, |
| if recursive is false, returns files in the directory; |
| if recursive is true, return files in the subtree rooted at the path. |
| If the path is a file, return the file's status and block locations. |
| |
| @param f is the path |
| @param recursive if the subdirectories need to be traversed recursively |
| |
| @return an iterator that traverses statuses of the files |
| |
| @throws FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </doc> |
| </method> |
| <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the current user's home directory in this filesystem. |
| The default implementation returns "/user/$USER/".]]> |
| </doc> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="new_dir" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Set the current working directory for the given file system. All relative |
| paths will be resolved relative to it. |
| |
| @param new_dir]]> |
| </doc> |
| </method> |
| <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the current working directory for the given file system |
| @return the directory pathname]]> |
| </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[Note: with the new FilesContext class, getWorkingDirectory() |
| will be removed. |
| The working directory is implemented in FilesContext. |
| |
| Some file systems like LocalFileSystem have an initial workingDir |
| that we use as the starting workingDir. For other file systems |
| like HDFS there is no built in notion of an inital workingDir. |
| |
| @return if there is built in notion of workingDir then it |
| is returned; else a null is returned.]]> |
| </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"/> |
| <doc> |
| <![CDATA[Call {@link #mkdirs(Path, FsPermission)} with default permission.]]> |
| </doc> |
| </method> |
| <method name="mkdirs" return="boolean" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Make the given file and all non-existent parents into |
| directories. Has the semantics of Unix 'mkdir -p'. |
| Existence of the directory hierarchy is not an error.]]> |
| </doc> |
| </method> |
| <method name="copyFromLocalFile" |
| 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[The src file is on the local disk. Add it to FS at |
| the given dst name and the source is kept intact afterwards]]> |
| </doc> |
| </method> |
| <method name="moveFromLocalFile" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcs" 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 files is on the local disk. Add it to FS at |
| the given dst name, removing the source afterwards.]]> |
| </doc> |
| </method> |
| <method name="moveFromLocalFile" |
| 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[The src file is on the local disk. Add it to FS at |
| the given dst name, removing the source afterwards.]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[The src file is on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </doc> |
| </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="overwrite" type="boolean"/> |
| <param name="srcs" 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 files are on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </doc> |
| </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="overwrite" 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 on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </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"/> |
| <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="moveToLocalFile" |
| 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[The src file is under FS, and the dst is on the local disk. |
| Copy it from FS control to the local dst name. |
| Remove the source afterwards]]> |
| </doc> |
| </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. |
| delSrc indicates if the src will be removed or not.]]> |
| </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"/> |
| <doc> |
| <![CDATA[Returns a local File that the user can write output to. The caller |
| provides both the eventual FS target name and the local working |
| file. If the FS is local, we write directly into the target. If |
| the FS is remote, we write into the tmp local area.]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[Called when we're all done writing to the target. A local FS will |
| do nothing, because we've written to exactly the right place. A remote |
| FS will copy the contents of tmpLocalFile to the correct target at |
| fsOutputFile.]]> |
| </doc> |
| </method> |
| <method name="close" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[No more filesystem operations are needed. Will |
| release any held locks.]]> |
| </doc> |
| </method> |
| <method name="getUsed" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the total size of all files in the filesystem.]]> |
| </doc> |
| </method> |
| <method name="getBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use getFileStatus() instead"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@deprecated Use getFileStatus() instead]]> |
| </doc> |
| </method> |
| <method name="getDefaultBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the number of bytes that large input files should be optimally |
| be split into to minimize i/o time.]]> |
| </doc> |
| </method> |
| <method name="getDefaultReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the default replication.]]> |
| </doc> |
| </method> |
| <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a file status object that represents the path. |
| @param f The path we want information from |
| @return a FileStatus object |
| @throws FileNotFoundException when the path does not exist; |
| IOException see specific implementation]]> |
| </doc> |
| </method> |
| <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum" |
| 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[Get the checksum of a file. |
| |
| @param f The file path |
| @return The file checksum. The default return value is null, |
| which indicates that no checksum algorithm is implemented |
| in the corresponding FileSystem.]]> |
| </doc> |
| </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 the verify checksum flag. This is only applicable if the |
| corresponding FileSystem supports checksum. By default doesn't do anything. |
| @param verifyChecksum]]> |
| </doc> |
| </method> |
| <method name="getStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns a status object describing the use and capacity of the |
| file system. If the file system has multiple partitions, the |
| use and capacity of the root partition is reflected. |
| |
| @return a FsStatus object |
| @throws IOException |
| see specific implementation]]> |
| </doc> |
| </method> |
| <method name="getStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns a status object describing the use and capacity of the |
| file system. If the file system has multiple partitions, the |
| use and capacity of the partition pointed to by the specified |
| path is reflected. |
| @param p Path for which status should be obtained. null means |
| the default partition. |
| @return a FsStatus object |
| @throws IOException |
| see specific implementation]]> |
| </doc> |
| </method> |
| <method name="setPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set permission of a path. |
| @param p |
| @param permission]]> |
| </doc> |
| </method> |
| <method name="setOwner" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="username" type="java.lang.String"/> |
| <param name="groupname" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set owner of a path (i.e. a file or a directory). |
| The parameters username and groupname cannot both be null. |
| @param p The path |
| @param username If it is null, the original username remains unchanged. |
| @param groupname If it is null, the original groupname remains unchanged.]]> |
| </doc> |
| </method> |
| <method name="setTimes" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="mtime" type="long"/> |
| <param name="atime" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Set access time of a file |
| @param p The path |
| @param mtime Set the modification time of this file. |
| The number of milliseconds since Jan 1, 1970. |
| A value of -1 means that this call should not set modification time. |
| @param atime Set the access time of this file. |
| The number of milliseconds since Jan 1, 1970. |
| A value of -1 means that this call should not set access time.]]> |
| </doc> |
| </method> |
| <method name="getStatistics" return="java.util.Map" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="use {@link #getAllStatistics} instead"> |
| <doc> |
| <![CDATA[Get the Map of Statistics object indexed by URI Scheme. |
| @return a Map having a key as URI scheme and value as Statistics object |
| @deprecated use {@link #getAllStatistics} instead]]> |
| </doc> |
| </method> |
| <method name="getAllStatistics" return="java.util.List" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the FileSystem classes that have Statistics]]> |
| </doc> |
| </method> |
| <method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| 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="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="printStatistics" |
| abstract="false" native="false" synchronized="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <field name="FS_DEFAULT_NAME_KEY" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="DEFAULT_FS" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="LOG" type="org.apache.commons.logging.Log" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <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[An abstract base class for a fairly generic filesystem. It |
| may be implemented as a distributed filesystem, or as a "local" |
| one that reflects the locally-connected disk. The local version |
| exists for small Hadoop instances and for testing. |
| |
| <p> |
| |
| All user code that may potentially use the Hadoop Distributed |
| File System should be written to use a FileSystem object. The |
| Hadoop DFS is a multi-machine system that appears as a single |
| disk. It's useful because of its fault tolerance and potentially |
| very large capacity. |
| |
| <p> |
| The local implementation is {@link LocalFileSystem} and distributed |
| implementation is DistributedFileSystem.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileSystem --> |
| <!-- start class org.apache.hadoop.fs.FileSystem.Statistics --> |
| <class name="FileSystem.Statistics" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FileSystem.Statistics" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="incrementBytesRead" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newBytes" type="long"/> |
| <doc> |
| <![CDATA[Increment the bytes read in the statistics |
| @param newBytes the additional bytes read]]> |
| </doc> |
| </method> |
| <method name="incrementBytesWritten" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newBytes" type="long"/> |
| <doc> |
| <![CDATA[Increment the bytes written in the statistics |
| @param newBytes the additional bytes written]]> |
| </doc> |
| </method> |
| <method name="incrementReadOps" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="count" type="int"/> |
| <doc> |
| <![CDATA[Increment the number of read operations |
| @param count number of read operations]]> |
| </doc> |
| </method> |
| <method name="incrementLargeReadOps" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="count" type="int"/> |
| <doc> |
| <![CDATA[Increment the number of large read operations |
| @param count number of large read operations]]> |
| </doc> |
| </method> |
| <method name="incrementWriteOps" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="count" type="int"/> |
| <doc> |
| <![CDATA[Increment the number of write operations |
| @param count number of write operations]]> |
| </doc> |
| </method> |
| <method name="getBytesRead" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the total number of bytes read |
| @return the number of bytes]]> |
| </doc> |
| </method> |
| <method name="getBytesWritten" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the total number of bytes written |
| @return the number of bytes]]> |
| </doc> |
| </method> |
| <method name="getReadOps" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the number of file system read operations such as list files |
| @return number of read operations]]> |
| </doc> |
| </method> |
| <method name="getLargeReadOps" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the number of large file system read operations such as list files |
| under a large directory |
| @return number of large read operations]]> |
| </doc> |
| </method> |
| <method name="getWriteOps" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the number of file system write operations such as create, append |
| rename etc. |
| @return number of write operations]]> |
| </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="reset" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Reset the counts of bytes to 0.]]> |
| </doc> |
| </method> |
| <method name="getScheme" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the uri scheme associated with this statistics object. |
| @return the schema associated with this set of statistics]]> |
| </doc> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileSystem.Statistics --> |
| <!-- start class org.apache.hadoop.fs.FileUtil --> |
| <class name="FileUtil" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FileUtil" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/> |
| <doc> |
| <![CDATA[convert an array of FileStatus to an array of Path |
| |
| @param stats |
| an array of FileStatus objects |
| @return an array of paths corresponding to the input]]> |
| </doc> |
| </method> |
| <method name="stat2Paths" return="org.apache.hadoop.fs.Path[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="stats" type="org.apache.hadoop.fs.FileStatus[]"/> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[convert an array of FileStatus to an array of Path. |
| If stats if null, return path |
| @param stats |
| an array of FileStatus objects |
| @param path |
| default path to return in stats is null |
| @return an array of paths corresponding to the input]]> |
| </doc> |
| </method> |
| <method name="fullyDelete" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Delete a directory and all its contents. If |
| we return false, the directory may be partially-deleted. |
| (1) If dir is symlink to a file, the symlink is deleted. The file pointed |
| to by the symlink is not deleted. |
| (2) If dir is symlink to a directory, symlink is deleted. The directory |
| pointed to by symlink is not deleted. |
| (3) If dir is a normal file, it is deleted. |
| (4) If dir is a normal directory, then dir and all its contents recursively |
| are deleted.]]> |
| </doc> |
| </method> |
| <method name="fullyDeleteContents" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Delete the contents of a directory, not the directory itself. If |
| we return false, the directory may be partially-deleted. |
| If dir is a symlink to a directory, all the contents of the actual |
| directory pointed to by dir will be deleted.]]> |
| </doc> |
| </method> |
| <method name="fullyDelete" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="Use {@link FileSystem#delete(Path, boolean)}"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Recursively delete a directory. |
| |
| @param fs {@link FileSystem} on which the path is present |
| @param dir directory to recursively delete |
| @throws IOException |
| @deprecated Use {@link FileSystem#delete(Path, boolean)}]]> |
| </doc> |
| </method> |
| <method name="copy" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy files between FileSystems.]]> |
| </doc> |
| </method> |
| <method name="copy" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="srcs" type="org.apache.hadoop.fs.Path[]"/> |
| <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="overwrite" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="copy" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="overwrite" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy files between FileSystems.]]> |
| </doc> |
| </method> |
| <method name="copyMerge" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="srcDir" type="org.apache.hadoop.fs.Path"/> |
| <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dstFile" type="org.apache.hadoop.fs.Path"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="addString" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy all files in a directory to one output file (merge).]]> |
| </doc> |
| </method> |
| <method name="copy" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="java.io.File"/> |
| <param name="dstFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dst" type="org.apache.hadoop.fs.Path"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy local files to a FileSystem.]]> |
| </doc> |
| </method> |
| <method name="copy" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="srcFS" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="src" type="org.apache.hadoop.fs.Path"/> |
| <param name="dst" type="java.io.File"/> |
| <param name="deleteSource" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copy FileSystem files to local files.]]> |
| </doc> |
| </method> |
| <method name="makeShellPath" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="filename" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Convert a os-native filename to a path that works for the shell. |
| @param filename The filename to convert |
| @return The unix pathname |
| @throws IOException on windows, there can be problems with the subprocess]]> |
| </doc> |
| </method> |
| <method name="makeShellPath" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Convert a os-native filename to a path that works for the shell. |
| @param file The filename to convert |
| @return The unix pathname |
| @throws IOException on windows, there can be problems with the subprocess]]> |
| </doc> |
| </method> |
| <method name="makeShellPath" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="java.io.File"/> |
| <param name="makeCanonicalPath" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Convert a os-native filename to a path that works for the shell. |
| @param file The filename to convert |
| @param makeCanonicalPath |
| Whether to make canonical path for the file passed |
| @return The unix pathname |
| @throws IOException on windows, there can be problems with the subprocess]]> |
| </doc> |
| </method> |
| <method name="getDU" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="java.io.File"/> |
| <doc> |
| <![CDATA[Takes an input dir and returns the du on that local directory. Very basic |
| implementation. |
| |
| @param dir |
| The input dir to get the disk space of this local dir |
| @return The total disk space of the input local directory]]> |
| </doc> |
| </method> |
| <method name="unZip" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="inFile" type="java.io.File"/> |
| <param name="unzipDir" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Given a File input it will unzip the file in a the unzip directory |
| passed as the second parameter |
| @param inFile The zip file as input |
| @param unzipDir The unzip directory where to unzip the zip file. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="unTar" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="inFile" type="java.io.File"/> |
| <param name="untarDir" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Given a Tar File as input it will untar the file in a the untar directory |
| passed as the second parameter |
| |
| This utility will untar ".tar" files and ".tar.gz","tgz" files. |
| |
| @param inFile The tar file as input. |
| @param untarDir The untar directory where to untar the tar file. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="symLink" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="target" type="java.lang.String"/> |
| <param name="linkname" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create a soft link between a src and destination |
| only on a local disk. HDFS does not support this |
| @param target the target for symlink |
| @param linkname the symlink |
| @return value returned by the command]]> |
| </doc> |
| </method> |
| <method name="chmod" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="filename" type="java.lang.String"/> |
| <param name="perm" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="InterruptedException" type="java.lang.InterruptedException"/> |
| <doc> |
| <![CDATA[Change the permissions on a filename. |
| @param filename the name of the file to change |
| @param perm the permission string |
| @return the exit code from the command |
| @throws IOException |
| @throws InterruptedException]]> |
| </doc> |
| </method> |
| <method name="chmod" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="filename" type="java.lang.String"/> |
| <param name="perm" type="java.lang.String"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <exception name="InterruptedException" type="java.lang.InterruptedException"/> |
| <doc> |
| <![CDATA[Change the permissions on a file / directory, recursively, if |
| needed. |
| @param filename name of the file whose permissions are to change |
| @param perm permission string |
| @param recursive true, if permissions should be changed recursively |
| @return the exit code from the command. |
| @throws IOException |
| @throws InterruptedException]]> |
| </doc> |
| </method> |
| <method name="createLocalTempFile" return="java.io.File" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <param name="basefile" type="java.io.File"/> |
| <param name="prefix" type="java.lang.String"/> |
| <param name="isDeleteOnExit" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create a tmp file for a base file. |
| @param basefile the base file of the tmp |
| @param prefix file name prefix of tmp |
| @param isDeleteOnExit if true, the tmp will be deleted when the VM exits |
| @return a newly created tmp file |
| @exception IOException If a tmp file cannot created |
| @see java.io.File#createTempFile(String, String, File) |
| @see java.io.File#deleteOnExit()]]> |
| </doc> |
| </method> |
| <method name="replaceFile" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="src" type="java.io.File"/> |
| <param name="target" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Move the src file to the name specified by target. |
| @param src the source file |
| @param target the target file |
| @exception IOException If this operation fails]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A collection of file-processing util methods]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileUtil --> |
| <!-- start class org.apache.hadoop.fs.FileUtil.HardLink --> |
| <class name="FileUtil.HardLink" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FileUtil.HardLink" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="createHardLink" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="target" type="java.io.File"/> |
| <param name="linkName" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Creates a hardlink]]> |
| </doc> |
| </method> |
| <method name="getLinkCount" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fileName" type="java.io.File"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Retrieves the number of links to the specified file.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Class for creating hardlinks. |
| Supports Unix, Cygwin, WindXP.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FileUtil.HardLink --> |
| <!-- start class org.apache.hadoop.fs.FilterFileSystem --> |
| <class name="FilterFileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FilterFileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FilterFileSystem" type="org.apache.hadoop.fs.FileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="name" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Called after a new FileSystem instance is constructed. |
| @param name a uri whose authority section names the host, port, etc. |
| for this FileSystem |
| @param conf the configuration]]> |
| </doc> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a URI whose scheme and authority identify this FileSystem.]]> |
| </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 sure that a path specifies a FileSystem.]]> |
| </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.]]> |
| </doc> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.FileStatus"/> |
| <param name="start" type="long"/> |
| <param name="len" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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="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. |
| |
| @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[Renames Path src to Path dst. Can take place on local fs |
| or remote DFS.]]> |
| </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[Delete a file]]> |
| </doc> |
| </method> |
| <method name="deleteOnExit" 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"/> |
| <doc> |
| <![CDATA[Mark a path to be deleted when FileSystem is closed. |
| When the JVM shuts down, |
| all FileSystem objects will be closed automatically. |
| Then, |
| the marked path will be deleted as a result of closing the FileSystem. |
| |
| The path has to exist in the file system. |
| |
| @param f the path to delete. |
| @return true if deleteOnExit is successful, otherwise false. |
| @throws IOException]]> |
| </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 files in a directory.]]> |
| </doc> |
| </method> |
| <method name="listLocatedStatus" return="org.apache.hadoop.fs.RemoteIterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[List files and its block locations in a directory.]]> |
| </doc> |
| </method> |
| <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newDir" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Set the current working directory for the given file system. All relative |
| paths will be resolved relative to it. |
| |
| @param newDir]]> |
| </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[Get the current working directory for the given file system |
| |
| @return the directory pathname]]> |
| </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"> |
| </method> |
| <method name="getStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </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"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[The src file is on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </doc> |
| </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="overwrite" type="boolean"/> |
| <param name="srcs" 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 files are on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </doc> |
| </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="overwrite" 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 on the local disk. Add it to FS at |
| the given dst name. |
| delSrc indicates if the source should be removed]]> |
| </doc> |
| </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. |
| delSrc indicates if the src will be removed or not.]]> |
| </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"/> |
| <doc> |
| <![CDATA[Returns a local File that the user can write output to. The caller |
| provides both the eventual FS target name and the local working |
| file. If the FS is local, we write directly into the target. If |
| the FS is remote, we write into the tmp local area.]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[Called when we're all done writing to the target. A local FS will |
| do nothing, because we've written to exactly the right place. A remote |
| FS will copy the contents of tmpLocalFile to the correct target at |
| fsOutputFile.]]> |
| </doc> |
| </method> |
| <method name="getUsed" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the total size of all files in the filesystem.]]> |
| </doc> |
| </method> |
| <method name="getDefaultBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the number of bytes that large input files should be optimally |
| be split into to minimize i/o time.]]> |
| </doc> |
| </method> |
| <method name="getDefaultReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the default replication.]]> |
| </doc> |
| </method> |
| <method name="getFileStatus" 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[Get file status.]]> |
| </doc> |
| </method> |
| <method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum" |
| 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[{@inheritDoc}]]> |
| </doc> |
| </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[{@inheritDoc}]]> |
| </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"> |
| </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> |
| <method name="setOwner" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="username" type="java.lang.String"/> |
| <param name="groupname" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="setTimes" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="mtime" type="long"/> |
| <param name="atime" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="setPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="flag" type="java.util.EnumSet"/> |
| <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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="primitiveMkdir" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="abdolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <field name="fs" type="org.apache.hadoop.fs.FileSystem" |
| transient="false" volatile="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[A <code>FilterFileSystem</code> contains |
| some other file system, which it uses as |
| its basic file system, possibly transforming |
| the data along the way or providing additional |
| functionality. The class <code>FilterFileSystem</code> |
| itself simply overrides all methods of |
| <code>FileSystem</code> with versions that |
| pass all requests to the contained file |
| system. Subclasses of <code>FilterFileSystem</code> |
| may further override some of these methods |
| and may also provide additional methods |
| and fields.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FilterFileSystem --> |
| <!-- start interface org.apache.hadoop.fs.FsConstants --> |
| <interface name="FsConstants" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <field name="LOCAL_FS_URI" type="java.net.URI" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="FTP_SCHEME" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="VIEWFS_URI" type="java.net.URI" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[ViewFs: viewFs file system (ie the mount file system on client side)]]> |
| </doc> |
| </field> |
| <field name="VIEWFS_SCHEME" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[FileSystem related constants.]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.FsConstants --> |
| <!-- start class org.apache.hadoop.fs.FSDataInputStream --> |
| <class name="FSDataInputStream" extends="java.io.DataInputStream" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.fs.Seekable"/> |
| <implements name="org.apache.hadoop.fs.PositionedReadable"/> |
| <implements name="java.io.Closeable"/> |
| <constructor name="FSDataInputStream" type="java.io.InputStream" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <method name="seek" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="desired" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getPos" 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="read" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <param name="offset" type="int"/> |
| <param name="length" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="readFully" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <param name="offset" type="int"/> |
| <param name="length" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="readFully" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="seekToNewSource" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="targetPos" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <doc> |
| <![CDATA[Utility that wraps a {@link FSInputStream} in a {@link DataInputStream} |
| and buffers input through a {@link BufferedInputStream}.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FSDataInputStream --> |
| <!-- start class org.apache.hadoop.fs.FSDataOutputStream --> |
| <class name="FSDataOutputStream" extends="java.io.DataOutputStream" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.fs.Syncable"/> |
| <constructor name="FSDataOutputStream" type="java.io.OutputStream" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="FSDataOutputStream" type="java.io.OutputStream, org.apache.hadoop.fs.FileSystem.Statistics, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <method name="getPos" 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> |
| <method name="getWrappedStream" return="java.io.OutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="sync" |
| 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="hflush" |
| 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="hsync" |
| 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[Utility that wraps a {@link OutputStream} in a {@link DataOutputStream}, |
| buffers output through a {@link BufferedOutputStream} and creates a checksum |
| file.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FSDataOutputStream --> |
| <!-- start class org.apache.hadoop.fs.FSError --> |
| <class name="FSError" extends="java.lang.Error" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Thrown for unexpected filesystem errors, presumed to reflect disk errors |
| in the native filesystem.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FSError --> |
| <!-- start class org.apache.hadoop.fs.FsServerDefaults --> |
| <class name="FsServerDefaults" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="FsServerDefaults" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FsServerDefaults" type="long, int, int, short, int" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getBytesPerChecksum" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getWritePacketSize" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getFileBufferSize" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="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> |
| <doc> |
| <![CDATA[Provides server default configuration values to clients.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FsServerDefaults --> |
| <!-- start class org.apache.hadoop.fs.FsStatus --> |
| <class name="FsStatus" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="FsStatus" type="long, long, long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a FsStatus object, using the specified statistics]]> |
| </doc> |
| </constructor> |
| <method name="getCapacity" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the capacity in bytes of the file system]]> |
| </doc> |
| </method> |
| <method name="getUsed" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the number of bytes used on the file system]]> |
| </doc> |
| </method> |
| <method name="getRemaining" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the number of remaining bytes on the file system]]> |
| </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"/> |
| </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> |
| <doc> |
| <![CDATA[This class is used to represent the capacity, free and used space on a |
| {@link FileSystem}.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.FsStatus --> |
| <!-- start class org.apache.hadoop.fs.InvalidPathException --> |
| <class name="InvalidPathException" extends="org.apache.hadoop.HadoopIllegalArgumentException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="InvalidPathException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs exception with the specified detail message. |
| |
| @param path invalid path.]]> |
| </doc> |
| </constructor> |
| <constructor name="InvalidPathException" type="java.lang.String, java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs exception with the specified detail message. |
| |
| @param path invalid path. |
| @param reason Reason <code>path</code> is invalid]]> |
| </doc> |
| </constructor> |
| <doc> |
| <![CDATA[Path string is invalid either because it has invalid characters or due to |
| other file system specific reasons.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.InvalidPathException --> |
| <!-- start class org.apache.hadoop.fs.LocalFileSystem --> |
| <class name="LocalFileSystem" extends="org.apache.hadoop.fs.ChecksumFileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="LocalFileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="LocalFileSystem" type="org.apache.hadoop.fs.FileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getRaw" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="pathToFile" return="java.io.File" |
| 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[Convert a path to a File.]]> |
| </doc> |
| </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"/> |
| </method> |
| <method name="reportChecksumFailure" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" 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[Moves files to a bad file directory on the same device, so that their |
| storage will not be reused.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Implement the FileSystem API for the checksumed local filesystem.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.LocalFileSystem --> |
| <!-- start class org.apache.hadoop.fs.LocatedFileStatus --> |
| <class name="LocatedFileStatus" extends="org.apache.hadoop.fs.FileStatus" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="LocatedFileStatus" type="org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.BlockLocation[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Constructor |
| @param stat a file status |
| @param locations a file's block locations]]> |
| </doc> |
| </constructor> |
| <constructor name="LocatedFileStatus" type="long, boolean, int, long, long, long, org.apache.hadoop.fs.permission.FsPermission, java.lang.String, java.lang.String, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path, org.apache.hadoop.fs.BlockLocation[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructor |
| |
| @param length a file's length |
| @param isdir if the path is a directory |
| @param block_replication the file's replication factor |
| @param blocksize a file's block size |
| @param modification_time a file's modification time |
| @param access_time a file's access time |
| @param permission a file's permission |
| @param owner a file's owner |
| @param group a file's group |
| @param symlink symlink if the path is a symbolic link |
| @param path the path's qualified name |
| @param locations a file's block locations]]> |
| </doc> |
| </constructor> |
| <method name="getBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the file's block locations |
| @return the file's block locations]]> |
| </doc> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compare this object to another object |
| |
| @param o the object to be compared. |
| @return a negative integer, zero, or a positive integer as this object |
| is less than, equal to, or greater than the specified object. |
| |
| @throws ClassCastException if the specified object's is not of |
| type FileStatus]]> |
| </doc> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compare if this object is equal to another object |
| @param o the object to be compared. |
| @return true if two file status has the same path name; false if not.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a hash code value for the object, which is defined as |
| the hash code of the path name. |
| |
| @return a hash code value for the path name.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[This class defines a FileStatus that includes a file's block locations.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.LocatedFileStatus --> |
| <!-- start class org.apache.hadoop.fs.Options --> |
| <class name="Options" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[This class contains options related to file system operations.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts --> |
| <class name="Options.CreateOpts" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="blockSize" return="org.apache.hadoop.fs.Options.CreateOpts.BlockSize" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="bs" type="long"/> |
| </method> |
| <method name="bufferSize" return="org.apache.hadoop.fs.Options.CreateOpts.BufferSize" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="bs" type="int"/> |
| </method> |
| <method name="repFac" return="org.apache.hadoop.fs.Options.CreateOpts.ReplicationFactor" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="rf" type="short"/> |
| </method> |
| <method name="bytesPerChecksum" return="org.apache.hadoop.fs.Options.CreateOpts.BytesPerChecksum" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="crc" type="short"/> |
| </method> |
| <method name="perms" return="org.apache.hadoop.fs.Options.CreateOpts.Perms" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="perm" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| </method> |
| <method name="createParent" return="org.apache.hadoop.fs.Options.CreateOpts.CreateParent" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="donotCreateParent" return="org.apache.hadoop.fs.Options.CreateOpts.CreateParent" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getOpt" return="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="theClass" type="java.lang.Class"/> |
| <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/> |
| <doc> |
| <![CDATA[Get an option of desired type |
| @param theClass is the desired class of the opt |
| @param opts - not null - at least one opt must be passed |
| @return an opt from one of the opts of type theClass. |
| returns null if there isn't any]]> |
| </doc> |
| </method> |
| <method name="setOpt" return="org.apache.hadoop.fs.Options.CreateOpts[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="newValue" type="T"/> |
| <param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/> |
| <doc> |
| <![CDATA[set an option |
| @param newValue the option to be set |
| @param opts - the option is set into this array of opts |
| @return updated CreateOpts[] == opts + newValue]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Class to support the varargs for create() options.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.BlockSize --> |
| <class name="Options.CreateOpts.BlockSize" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.BlockSize" type="long" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.BlockSize --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.BufferSize --> |
| <class name="Options.CreateOpts.BufferSize" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.BufferSize" type="int" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.BufferSize --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.BytesPerChecksum --> |
| <class name="Options.CreateOpts.BytesPerChecksum" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.BytesPerChecksum" type="short" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.BytesPerChecksum --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.CreateParent --> |
| <class name="Options.CreateOpts.CreateParent" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.CreateParent" type="boolean" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.CreateParent --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.Perms --> |
| <class name="Options.CreateOpts.Perms" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.Perms" type="org.apache.hadoop.fs.permission.FsPermission" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.Perms --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.Progress --> |
| <class name="Options.CreateOpts.Progress" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.Progress" type="org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="org.apache.hadoop.util.Progressable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.Progress --> |
| <!-- start class org.apache.hadoop.fs.Options.CreateOpts.ReplicationFactor --> |
| <class name="Options.CreateOpts.ReplicationFactor" extends="org.apache.hadoop.fs.Options.CreateOpts" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Options.CreateOpts.ReplicationFactor" type="short" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValue" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.CreateOpts.ReplicationFactor --> |
| <!-- start class org.apache.hadoop.fs.Options.Rename --> |
| <class name="Options.Rename" extends="java.lang.Enum" |
| abstract="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <method name="values" return="org.apache.hadoop.fs.Options.Rename[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="valueOf" return="org.apache.hadoop.fs.Options.Rename" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="name" type="java.lang.String"/> |
| </method> |
| <method name="valueOf" return="org.apache.hadoop.fs.Options.Rename" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="code" type="byte"/> |
| </method> |
| <method name="value" return="byte" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <doc> |
| <![CDATA[Enum to support the varargs for rename() options]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Options.Rename --> |
| <!-- start class org.apache.hadoop.fs.ParentNotDirectoryException --> |
| <class name="ParentNotDirectoryException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ParentNotDirectoryException" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ParentNotDirectoryException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Indicates that the parent of specified Path is not a directory |
| as expected.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ParentNotDirectoryException --> |
| <!-- start class org.apache.hadoop.fs.Path --> |
| <class name="Path" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.Comparable"/> |
| <constructor name="Path" type="java.lang.String, java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Resolve a child path against a parent path.]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="org.apache.hadoop.fs.Path, java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Resolve a child path against a parent path.]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="java.lang.String, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Resolve a child path against a parent path.]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="org.apache.hadoop.fs.Path, org.apache.hadoop.fs.Path" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Resolve a child path against a parent path.]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a path from a String. Path strings are URIs, but with |
| unescaped elements and some additional normalization.]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="java.net.URI" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a path from a URI]]> |
| </doc> |
| </constructor> |
| <constructor name="Path" type="java.lang.String, java.lang.String, java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a Path from components.]]> |
| </doc> |
| </constructor> |
| <method name="toUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Convert this to a URI.]]> |
| </doc> |
| </method> |
| <method name="getFileSystem" return="org.apache.hadoop.fs.FileSystem" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the FileSystem that owns this Path.]]> |
| </doc> |
| </method> |
| <method name="isAbsoluteAndSchemeAuthorityNull" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Is an absolute path (ie a slash relative path part) |
| AND a scheme is null AND authority is null.]]> |
| </doc> |
| </method> |
| <method name="isUriPathAbsolute" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[True if the path component (i.e. directory) of this URI is absolute.]]> |
| </doc> |
| </method> |
| <method name="isAbsolute" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[There is some ambiguity here. An absolute path is a slash |
| relative name without a scheme or an authority. |
| So either this method was incorrectly named or its |
| implementation is incorrect. This method returns true |
| even if there is a scheme and authority.]]> |
| </doc> |
| </method> |
| <method name="getName" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the final component of this path.]]> |
| </doc> |
| </method> |
| <method name="getParent" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the parent of a path or null if at root.]]> |
| </doc> |
| </method> |
| <method name="suffix" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="suffix" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Adds a suffix to the final name in the path.]]> |
| </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="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| </method> |
| <method name="depth" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the number of elements in this path.]]> |
| </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="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <doc> |
| <![CDATA[Returns a qualified path object. |
| |
| Deprecated - use {@link #makeQualified(URI, Path)}]]> |
| </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="defaultUri" type="java.net.URI"/> |
| <param name="workingDir" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Returns a qualified path object.]]> |
| </doc> |
| </method> |
| <field name="SEPARATOR" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The directory separator, a slash.]]> |
| </doc> |
| </field> |
| <field name="SEPARATOR_CHAR" type="char" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="CUR_DIR" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[Names a file or directory in a {@link FileSystem}. |
| Path strings use slash as the directory separator. A path string is |
| absolute if it begins with a slash.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Path --> |
| <!-- start interface org.apache.hadoop.fs.PathFilter --> |
| <interface name="PathFilter" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="accept" return="boolean" |
| 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[Tests whether or not the specified abstract pathname should be |
| included in a pathname list. |
| |
| @param path The abstract pathname to be tested |
| @return <code>true</code> if and only if <code>pathname</code> |
| should be included]]> |
| </doc> |
| </method> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.PathFilter --> |
| <!-- start interface org.apache.hadoop.fs.PositionedReadable --> |
| <interface name="PositionedReadable" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="read" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <param name="offset" type="int"/> |
| <param name="length" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read upto the specified number of bytes, from a given |
| position within a file, and return the number of bytes read. This does not |
| change the current offset of a file, and is thread-safe.]]> |
| </doc> |
| </method> |
| <method name="readFully" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <param name="offset" type="int"/> |
| <param name="length" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read the specified number of bytes, from a given |
| position within a file. This does not |
| change the current offset of a file, and is thread-safe.]]> |
| </doc> |
| </method> |
| <method name="readFully" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="position" type="long"/> |
| <param name="buffer" type="byte[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read number of bytes equalt to the length of the buffer, from a given |
| position within a file. This does not |
| change the current offset of a file, and is thread-safe.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Stream that permits positional reading.]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.PositionedReadable --> |
| <!-- start class org.apache.hadoop.fs.RawLocalFileSystem --> |
| <class name="RawLocalFileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="RawLocalFileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="pathToFile" return="java.io.File" |
| 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[Convert a path to a File.]]> |
| </doc> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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="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="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="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="primitiveCreate" return="org.apache.hadoop.fs.FSDataOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <param name="flag" type="java.util.EnumSet"/> |
| <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"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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"/> |
| <doc> |
| <![CDATA[Creates the specified directory hierarchy. Does not |
| treat existence as an error.]]> |
| </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"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="primitiveMkdir" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="f" type="org.apache.hadoop.fs.Path"/> |
| <param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newDir" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Set the working directory to the given directory.]]> |
| </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"> |
| </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"> |
| </method> |
| <method name="getStatus" return="org.apache.hadoop.fs.FsStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="moveFromLocalFile" |
| 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"/> |
| </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="fsWorkingFile" 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="close" |
| 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="toString" return="java.lang.String" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getFileStatus" 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"/> |
| </method> |
| <method name="setOwner" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="username" type="java.lang.String"/> |
| <param name="groupname" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Use the command chown to set owner.]]> |
| </doc> |
| </method> |
| <method name="setPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="p" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Use the command chmod to set permission.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Implement the FileSystem API for the raw local filesystem.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.RawLocalFileSystem --> |
| <!-- start interface org.apache.hadoop.fs.RemoteIterator --> |
| <interface name="RemoteIterator" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="hasNext" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns <tt>true</tt> if the iteration has more elements. |
| |
| @return <tt>true</tt> if the iterator has more elements. |
| @throws IOException if any IO error occurs]]> |
| </doc> |
| </method> |
| <method name="next" return="E" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns the next element in the iteration. |
| |
| @return the next element in the iteration. |
| @throws NoSuchElementException iteration has no more elements. |
| @throws IOException if any IO error occurs]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[An iterator over a collection whose elements need to be fetched remotely]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.RemoteIterator --> |
| <!-- start interface org.apache.hadoop.fs.Seekable --> |
| <interface name="Seekable" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="seek" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="pos" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Seek to the given offset from the start of the file. |
| The next read() will be from that location. Can't |
| seek past the end of the file.]]> |
| </doc> |
| </method> |
| <method name="getPos" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the current offset from the start of the file]]> |
| </doc> |
| </method> |
| <method name="seekToNewSource" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="targetPos" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Seeks a different copy of the data. Returns true if |
| found a new source, false otherwise.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Stream that permits seeking.]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.Seekable --> |
| <!-- start interface org.apache.hadoop.fs.Syncable --> |
| <interface name="Syncable" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="sync" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="As of HADOOP 0.21.0, replaced by hflush"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@deprecated As of HADOOP 0.21.0, replaced by hflush |
| @see #hflush()]]> |
| </doc> |
| </method> |
| <method name="hflush" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Flush out the data in client's user buffer. After the return of |
| this call, new readers will see the data. |
| @throws IOException if any error occurs]]> |
| </doc> |
| </method> |
| <method name="hsync" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Similar to posix fsync, flush out the data in client's user buffer |
| all the way to the disk device (but the disk may have it in its cache). |
| @throws IOException if error occurs]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[This interface for flush/sync operation.]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.fs.Syncable --> |
| <!-- start class org.apache.hadoop.fs.Trash --> |
| <class name="Trash" extends="org.apache.hadoop.conf.Configured" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="Trash" type="org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct a trash can accessor. |
| @param conf a Configuration]]> |
| </doc> |
| </constructor> |
| <constructor name="Trash" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct a trash can accessor for the FileSystem provided.]]> |
| </doc> |
| </constructor> |
| <method name="moveToTrash" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Move a file or directory to the current trash directory. |
| @return false if the item is already in the trash or trash is disabled]]> |
| </doc> |
| </method> |
| <method name="checkpoint" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create a trash checkpoint.]]> |
| </doc> |
| </method> |
| <method name="expunge" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Delete old checkpoints.]]> |
| </doc> |
| </method> |
| <method name="getEmptier" return="java.lang.Runnable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return a {@link Runnable} that periodically empties the trash of all |
| users, intended to be run by the superuser. Only one checkpoint is kept |
| at a time.]]> |
| </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[Run an emptier.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Provides a <i>trash</i> feature. Files are moved to a user's trash |
| directory, a subdirectory of their home directory named ".Trash". Files are |
| initially moved to a <i>current</i> sub-directory of the trash directory. |
| Within that sub-directory their original path is preserved. Periodically |
| one may checkpoint the current trash and remove older checkpoints. (This |
| design permits trash management without enumeration of the full trash |
| content, without date support in the filesystem, and without clock |
| synchronization.)]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.Trash --> |
| <!-- start class org.apache.hadoop.fs.UnsupportedFileSystemException --> |
| <class name="UnsupportedFileSystemException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="UnsupportedFileSystemException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs exception with the specified detail message. |
| @param message exception message.]]> |
| </doc> |
| </constructor> |
| <doc> |
| <![CDATA[File system for a given file system name/scheme is not supported]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.UnsupportedFileSystemException --> |
| <doc> |
| <![CDATA[An abstract file system API.]]> |
| </doc> |
| </package> |
| <package name="org.apache.hadoop.fs.ftp"> |
| <!-- start class org.apache.hadoop.fs.ftp.FTPException --> |
| <class name="FTPException" extends="java.lang.RuntimeException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FTPException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FTPException" type="java.lang.Throwable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FTPException" type="java.lang.String, java.lang.Throwable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[A class to wrap a {@link Throwable} into a Runtime Exception.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ftp.FTPException --> |
| <!-- start class org.apache.hadoop.fs.ftp.FTPFileSystem --> |
| <class name="FTPFileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FTPFileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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="file" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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="file" 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[A stream obtained via this call must be closed before using other APIs of |
| this class or else the invocation will block.]]> |
| </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[This optional operation is not yet supported.]]> |
| </doc> |
| </method> |
| <method name="delete" return="boolean" |
| 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="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </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="file" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="mkdirs" return="boolean" |
| 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="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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"> |
| </method> |
| <method name="getHomeDirectory" return="org.apache.hadoop.fs.Path" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newDir" type="org.apache.hadoop.fs.Path"/> |
| </method> |
| <field name="LOG" type="org.apache.commons.logging.Log" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="DEFAULT_BUFFER_SIZE" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="DEFAULT_BLOCK_SIZE" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[<p> |
| A {@link FileSystem} backed by an FTP client provided by <a |
| href="http://commons.apache.org/net/">Apache Commons Net</a>. |
| </p>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.ftp.FTPFileSystem --> |
| </package> |
| <package name="org.apache.hadoop.fs.kfs"> |
| <!-- start class org.apache.hadoop.fs.kfs.KosmosFileSystem --> |
| <class name="KosmosFileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="KosmosFileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| </method> |
| <method name="mkdirs" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="isDirectory" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="isFile" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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="file" 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"/> |
| </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="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getDefaultReplication" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setReplication" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="replication" type="short"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getDefaultBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="lock" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="shared" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="release" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="file" type="org.apache.hadoop.fs.FileStatus"/> |
| <param name="start" type="long"/> |
| <param name="len" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return null if the file doesn't exist; otherwise, get the |
| locations of the various chunks of the file file from KFS.]]> |
| </doc> |
| </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"/> |
| </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> |
| <doc> |
| <![CDATA[A FileSystem backed by KFS.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.kfs.KosmosFileSystem --> |
| <doc> |
| <![CDATA[<h1>A client for the Kosmos filesystem (KFS)</h1> |
| |
| <h3>Introduction</h3> |
| |
| This pages describes how to use Kosmos Filesystem |
| (<a href="http://kosmosfs.sourceforge.net"> KFS </a>) as a backing |
| store with Hadoop. This page assumes that you have downloaded the |
| KFS software and installed necessary binaries as outlined in the KFS |
| documentation. |
| |
| <h3>Steps</h3> |
| |
| <ul> |
| <li>In the Hadoop conf directory edit core-site.xml, |
| add the following: |
| <pre> |
| <property> |
| <name>fs.kfs.impl</name> |
| <value>org.apache.hadoop.fs.kfs.KosmosFileSystem</value> |
| <description>The FileSystem for kfs: uris.</description> |
| </property> |
| </pre> |
| |
| <li>In the Hadoop conf directory edit core-site.xml, |
| adding the following (with appropriate values for |
| <server> and <port>): |
| <pre> |
| <property> |
| <name>fs.default.name</name> |
| <value>kfs://<server:port></value> |
| </property> |
| |
| <property> |
| <name>fs.kfs.metaServerHost</name> |
| <value><server></value> |
| <description>The location of the KFS meta server.</description> |
| </property> |
| |
| <property> |
| <name>fs.kfs.metaServerPort</name> |
| <value><port></value> |
| <description>The location of the meta server's port.</description> |
| </property> |
| |
| </pre> |
| </li> |
| |
| <li>Copy KFS's <i> kfs-0.1.jar </i> to Hadoop's lib directory. This step |
| enables Hadoop's to load the KFS specific modules. Note |
| that, kfs-0.1.jar was built when you compiled KFS source |
| code. This jar file contains code that calls KFS's client |
| library code via JNI; the native code is in KFS's <i> |
| libkfsClient.so </i> library. |
| </li> |
| |
| <li> When the Hadoop map/reduce trackers start up, those |
| processes (on local as well as remote nodes) will now need to load |
| KFS's <i> libkfsClient.so </i> library. To simplify this process, it is advisable to |
| store libkfsClient.so in an NFS accessible directory (similar to where |
| Hadoop binaries/scripts are stored); then, modify Hadoop's |
| conf/hadoop-env.sh adding the following line and providing suitable |
| value for <path>: |
| <pre> |
| export LD_LIBRARY_PATH=<path> |
| </pre> |
| |
| |
| <li>Start only the map/reduce trackers |
| <br /> |
| example: execute Hadoop's bin/start-mapred.sh</li> |
| </ul> |
| <br/> |
| |
| If the map/reduce job trackers start up, all file-I/O is done to KFS.]]> |
| </doc> |
| </package> |
| <package name="org.apache.hadoop.fs.permission"> |
| <!-- start class org.apache.hadoop.fs.permission.AccessControlException --> |
| <class name="AccessControlException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use {@link org.apache.hadoop.security.AccessControlException} |
| instead."> |
| <constructor name="AccessControlException" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default constructor is needed for unwrapping from |
| {@link org.apache.hadoop.ipc.RemoteException}.]]> |
| </doc> |
| </constructor> |
| <constructor name="AccessControlException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs an {@link AccessControlException} |
| with the specified detail message. |
| @param s the detail message.]]> |
| </doc> |
| </constructor> |
| <constructor name="AccessControlException" type="java.lang.Throwable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs a new exception with the specified cause and a detail |
| message of <tt>(cause==null ? null : cause.toString())</tt> (which |
| typically contains the class and detail message of <tt>cause</tt>). |
| @param cause the cause (which is saved for later retrieval by the |
| {@link #getCause()} method). (A <tt>null</tt> value is |
| permitted, and indicates that the cause is nonexistent or |
| unknown.)]]> |
| </doc> |
| </constructor> |
| <doc> |
| <![CDATA[An exception class for access control related issues. |
| @deprecated Use {@link org.apache.hadoop.security.AccessControlException} |
| instead.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.permission.AccessControlException --> |
| <!-- start class org.apache.hadoop.fs.permission.FsPermission --> |
| <class name="FsPermission" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct by the given {@link FsAction}. |
| @param u user action |
| @param g group action |
| @param o other action]]> |
| </doc> |
| </constructor> |
| <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, org.apache.hadoop.fs.permission.FsAction, boolean" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FsPermission" type="short" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct by the given mode. |
| @param mode |
| @see #toShort()]]> |
| </doc> |
| </constructor> |
| <constructor name="FsPermission" type="org.apache.hadoop.fs.permission.FsPermission" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Copy constructor |
| |
| @param other other permission]]> |
| </doc> |
| </constructor> |
| <constructor name="FsPermission" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct by given mode, either in octal or symbolic format. |
| @param mode mode as a string, either in octal or symbolic format |
| @throws IllegalArgumentException if <code>mode</code> is invalid]]> |
| </doc> |
| </constructor> |
| <method name="createImmutable" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="permission" type="short"/> |
| <doc> |
| <![CDATA[Create an immutable {@link FsPermission} object.]]> |
| </doc> |
| </method> |
| <method name="getUserAction" return="org.apache.hadoop.fs.permission.FsAction" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return user {@link FsAction}.]]> |
| </doc> |
| </method> |
| <method name="getGroupAction" return="org.apache.hadoop.fs.permission.FsAction" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return group {@link FsAction}.]]> |
| </doc> |
| </method> |
| <method name="getOtherAction" return="org.apache.hadoop.fs.permission.FsAction" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return other {@link FsAction}.]]> |
| </doc> |
| </method> |
| <method name="fromShort" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="n" type="short"/> |
| </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="read" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create and initialize a {@link FsPermission} from {@link DataInput}.]]> |
| </doc> |
| </method> |
| <method name="toShort" return="short" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Encode the object to a short.]]> |
| </doc> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="obj" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </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> |
| <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="applyUMask" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <doc> |
| <![CDATA[Apply a umask to this permission and return a new one]]> |
| </doc> |
| </method> |
| <method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <doc> |
| <![CDATA[Get the user file creation mask (umask) |
| |
| {@code UMASK_LABEL} config param has umask value that is either symbolic |
| or octal. |
| |
| Symbolic umask is applied relative to file mode creation mask; |
| the permission op characters '+' clears the corresponding bit in the mask, |
| '-' sets bits in the mask. |
| |
| Octal umask, the specified bits are set in the file mode creation mask. |
| |
| {@code DEPRECATED_UMASK_LABEL} config param has umask value set to decimal.]]> |
| </doc> |
| </method> |
| <method name="getStickyBit" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setUMask" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="umask" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <doc> |
| <![CDATA[Set the user file creation mask (umask)]]> |
| </doc> |
| </method> |
| <method name="getDefault" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the default permission.]]> |
| </doc> |
| </method> |
| <method name="valueOf" return="org.apache.hadoop.fs.permission.FsPermission" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="unixSymbolicPermission" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Create a FsPermission from a Unix symbolic permission string |
| @param unixSymbolicPermission e.g. "-rw-rw-rw-"]]> |
| </doc> |
| </method> |
| <field name="DEPRECATED_UMASK_LABEL" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[umask property label deprecated key and code in getUMask method |
| to accommodate it may be removed in version .23]]> |
| </doc> |
| </field> |
| <field name="UMASK_LABEL" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="DEFAULT_UMASK" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[A class for file/directory permissions.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.permission.FsPermission --> |
| </package> |
| <package name="org.apache.hadoop.fs.s3"> |
| <!-- start class org.apache.hadoop.fs.s3.MigrationTool --> |
| <class name="MigrationTool" extends="org.apache.hadoop.conf.Configured" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.util.Tool"/> |
| <constructor name="MigrationTool" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <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"/> |
| </method> |
| <method name="run" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="args" type="java.lang.String[]"/> |
| <exception name="Exception" type="java.lang.Exception"/> |
| </method> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <doc> |
| <![CDATA[<p> |
| This class is a tool for migrating data from an older to a newer version |
| of an S3 filesystem. |
| </p> |
| <p> |
| All files in the filesystem are migrated by re-writing the block metadata |
| - no datafiles are touched. |
| </p>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3.MigrationTool --> |
| <!-- start class org.apache.hadoop.fs.s3.S3Exception --> |
| <class name="S3Exception" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="S3Exception" type="java.lang.Throwable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Thrown if there is a problem communicating with Amazon S3.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3.S3Exception --> |
| <!-- start class org.apache.hadoop.fs.s3.S3FileSystem --> |
| <class name="S3FileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="S3FileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="S3FileSystem" type="org.apache.hadoop.fs.s3.FileSystemStore" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| </method> |
| <method name="mkdirs" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[@param permission Currently ignored.]]> |
| </doc> |
| </method> |
| <method name="isFile" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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[This optional operation is not yet supported.]]> |
| </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="file" 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[@param permission Currently ignored.]]> |
| </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="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="bufferSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </method> |
| <method name="delete" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="path" type="org.apache.hadoop.fs.Path"/> |
| <param name="recursive" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getFileStatus" 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[FileStatus for S3 file systems.]]> |
| </doc> |
| </method> |
| <method name="getDefaultBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <doc> |
| <![CDATA[<p> |
| A block-based {@link FileSystem} backed by |
| <a href="http://aws.amazon.com/s3">Amazon S3</a>. |
| </p> |
| @see NativeS3FileSystem]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3.S3FileSystem --> |
| <!-- start class org.apache.hadoop.fs.s3.S3FileSystemException --> |
| <class name="S3FileSystemException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="S3FileSystemException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Thrown when there is a fatal exception while using {@link S3FileSystem}.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3.S3FileSystemException --> |
| <!-- start class org.apache.hadoop.fs.s3.VersionMismatchException --> |
| <class name="VersionMismatchException" extends="org.apache.hadoop.fs.s3.S3FileSystemException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="VersionMismatchException" type="java.lang.String, java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Thrown when Hadoop cannot read the version of the data stored |
| in {@link S3FileSystem}.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3.VersionMismatchException --> |
| <doc> |
| <![CDATA[<p>A distributed, block-based implementation of {@link |
| org.apache.hadoop.fs.FileSystem} that uses <a href="http://aws.amazon.com/s3">Amazon S3</a> |
| as a backing store.</p> |
| |
| <p> |
| Files are stored in S3 as blocks (represented by |
| {@link org.apache.hadoop.fs.s3.Block}), which have an ID and a length. |
| Block metadata is stored in S3 as a small record (represented by |
| {@link org.apache.hadoop.fs.s3.INode}) using the URL-encoded |
| path string as a key. Inodes record the file type (regular file or directory) and the list of blocks. |
| This design makes it easy to seek to any given position in a file by reading the inode data to compute |
| which block to access, then using S3's support for |
| <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.2">HTTP Range</a> headers |
| to start streaming from the correct position. |
| Renames are also efficient since only the inode is moved (by a DELETE followed by a PUT since |
| S3 does not support renames). |
| </p> |
| <p> |
| For a single file <i>/dir1/file1</i> which takes two blocks of storage, the file structure in S3 |
| would be something like this: |
| </p> |
| <pre> |
| / |
| /dir1 |
| /dir1/file1 |
| block-6415776850131549260 |
| block-3026438247347758425 |
| </pre> |
| <p> |
| Inodes start with a leading <code>/</code>, while blocks are prefixed with <code>block-</code>. |
| </p>]]> |
| </doc> |
| </package> |
| <package name="org.apache.hadoop.fs.s3native"> |
| <!-- start class org.apache.hadoop.fs.s3native.NativeS3FileSystem --> |
| <class name="NativeS3FileSystem" extends="org.apache.hadoop.fs.FileSystem" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="NativeS3FileSystem" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="NativeS3FileSystem" type="org.apache.hadoop.fs.s3native.NativeFileSystemStore" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="initialize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="uri" type="java.net.URI"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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[This optional operation is not yet supported.]]> |
| </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"/> |
| </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="recurse" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getFileStatus" 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"/> |
| </method> |
| <method name="getUri" return="java.net.URI" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </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[<p> |
| If <code>f</code> is a file, this method will make a single call to S3. |
| If <code>f</code> is a directory, this method will make a maximum of |
| (<i>n</i> / 1000) + 2 calls to S3, where <i>n</i> is the total number of |
| files and directories contained directly in <code>f</code>. |
| </p>]]> |
| </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"/> |
| <param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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"/> |
| </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"/> |
| </method> |
| <method name="getDefaultBlockSize" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="setWorkingDirectory" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newDir" type="org.apache.hadoop.fs.Path"/> |
| <doc> |
| <![CDATA[Set the working directory to the given directory.]]> |
| </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"> |
| </method> |
| <field name="LOG" type="org.apache.commons.logging.Log" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[<p> |
| A {@link FileSystem} for reading and writing files stored on |
| <a href="http://aws.amazon.com/s3">Amazon S3</a>. |
| Unlike {@link org.apache.hadoop.fs.s3.S3FileSystem} this implementation |
| stores files on S3 in their |
| native form so they can be read by other S3 tools. |
| |
| A note about directories. S3 of course has no "native" support for them. |
| The idiom we choose then is: for any directory created by this class, |
| we use an empty object "#{dirpath}_$folder$" as a marker. |
| Further, to interoperate with other S3 tools, we also accept the following: |
| - an object "#{dirpath}/' denoting a directory marker |
| - if there exists any objects with the prefix "#{dirpath}/", then the |
| directory is said to exist |
| - if both a file with the name of a directory and a marker for that |
| directory exists, then the *file masks the directory*, and the directory |
| is never returned. |
| </p> |
| @see org.apache.hadoop.fs.s3.S3FileSystem]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.fs.s3native.NativeS3FileSystem --> |
| <doc> |
| <![CDATA[<p> |
| A distributed implementation of {@link |
| org.apache.hadoop.fs.FileSystem} for reading and writing files on |
| <a href="http://aws.amazon.com/s3">Amazon S3</a>. |
| Unlike {@link org.apache.hadoop.fs.s3.S3FileSystem}, which is block-based, |
| this implementation stores |
| files on S3 in their native form for interoperability with other S3 tools. |
| </p>]]> |
| </doc> |
| </package> |
| <package name="org.apache.hadoop.io"> |
| <!-- start class org.apache.hadoop.io.AbstractMapWritable --> |
| <class name="AbstractMapWritable" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <implements name="org.apache.hadoop.conf.Configurable"/> |
| <constructor name="AbstractMapWritable" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[constructor.]]> |
| </doc> |
| </constructor> |
| <method name="addToMap" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="clazz" type="java.lang.Class"/> |
| <doc> |
| <![CDATA[Add a Class to the maps if it is not already present.]]> |
| </doc> |
| </method> |
| <method name="getClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="id" type="byte"/> |
| <doc> |
| <![CDATA[@return the Class class for the specified id]]> |
| </doc> |
| </method> |
| <method name="getId" return="byte" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="clazz" type="java.lang.Class"/> |
| <doc> |
| <![CDATA[@return the id for the specified Class]]> |
| </doc> |
| </method> |
| <method name="copy" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="other" type="org.apache.hadoop.io.Writable"/> |
| <doc> |
| <![CDATA[Used by child copy constructors.]]> |
| </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 conf]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[@param conf the conf to set]]> |
| </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> |
| <doc> |
| <![CDATA[Abstract base class for MapWritable and SortedMapWritable |
| |
| Unlike org.apache.nutch.crawl.MapWritable, this class allows creation of |
| MapWritable<Writable, MapWritable> so the CLASS_TO_ID and ID_TO_CLASS |
| maps travel with the class instead of being static. |
| |
| Class ids range from 1 to 127 so there can be at most 127 distinct classes |
| in any specific map instance.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.AbstractMapWritable --> |
| <!-- start class org.apache.hadoop.io.ArrayFile --> |
| <class name="ArrayFile" extends="org.apache.hadoop.io.MapFile" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ArrayFile" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[A dense file-based mapping from integers to values.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ArrayFile --> |
| <!-- start class org.apache.hadoop.io.ArrayFile.Reader --> |
| <class name="ArrayFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ArrayFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct an array reader for the named file.]]> |
| </doc> |
| </constructor> |
| <method name="seek" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="n" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Positions the reader before its <code>n</code>th value.]]> |
| </doc> |
| </method> |
| <method name="next" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read and return the next value in the file.]]> |
| </doc> |
| </method> |
| <method name="key" return="long" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Returns the key associated with the most recent call to {@link |
| #seek(long)}, {@link #next(Writable)}, or {@link |
| #get(long,Writable)}.]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="n" type="long"/> |
| <param name="value" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the <code>n</code>th value in the file.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Provide access to an existing array file.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ArrayFile.Reader --> |
| <!-- start class org.apache.hadoop.io.ArrayFile.Writer --> |
| <class name="ArrayFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ArrayFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named file for values of the named class.]]> |
| </doc> |
| </constructor> |
| <constructor name="ArrayFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named file for values of the named class.]]> |
| </doc> |
| </constructor> |
| <method name="append" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Append a value to the file.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Write a new array file.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ArrayFile.Writer --> |
| <!-- start class org.apache.hadoop.io.ArrayPrimitiveWritable --> |
| <class name="ArrayPrimitiveWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="ArrayPrimitiveWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct an empty instance, for use during Writable read]]> |
| </doc> |
| </constructor> |
| <constructor name="ArrayPrimitiveWritable" type="java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct an instance of known type but no value yet |
| for use with type-specific wrapper classes]]> |
| </doc> |
| </constructor> |
| <constructor name="ArrayPrimitiveWritable" type="java.lang.Object" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Wrap an existing array of primitives |
| @param value - array of primitives]]> |
| </doc> |
| </constructor> |
| <method name="get" return="java.lang.Object" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the original array. |
| Client must cast it back to type componentType[] |
| (or may use type-specific wrapper classes). |
| @return - original array as Object]]> |
| </doc> |
| </method> |
| <method name="getComponentType" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="getDeclaredComponentType" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="isDeclaredComponentType" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="componentType" type="java.lang.Class"/> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="java.lang.Object"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="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> |
| <doc> |
| <![CDATA[This is a wrapper class. It wraps a Writable implementation around |
| an array of primitives (e.g., int[], long[], etc.), with optimized |
| wire format, and without creating new objects per element. |
| |
| This is a wrapper class only; it does not make a copy of the |
| underlying array.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ArrayPrimitiveWritable --> |
| <!-- start class org.apache.hadoop.io.ArrayWritable --> |
| <class name="ArrayWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="ArrayWritable" type="java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ArrayWritable" type="java.lang.String[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getValueClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="toStrings" return="java.lang.String[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="toArray" return="java.lang.Object" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="values" type="org.apache.hadoop.io.Writable[]"/> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </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[A Writable for arrays containing instances of a class. The elements of this |
| writable must all be instances of the same class. If this writable will be |
| the input for a Reducer, you will need to create a subclass that sets the |
| value to be of the proper type. |
| |
| For example: |
| <code> |
| public class IntArrayWritable extends ArrayWritable { |
| public IntArrayWritable() { |
| super(IntWritable.class); |
| } |
| } |
| </code>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ArrayWritable --> |
| <!-- start class org.apache.hadoop.io.BinaryComparable --> |
| <class name="BinaryComparable" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.lang.Comparable"/> |
| <constructor name="BinaryComparable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="getLength" return="int" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return n st bytes 0..n-1 from {#getBytes()} are valid.]]> |
| </doc> |
| </method> |
| <method name="getBytes" return="byte[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return representative byte array for this instance.]]> |
| </doc> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="other" type="org.apache.hadoop.io.BinaryComparable"/> |
| <doc> |
| <![CDATA[Compare bytes from {#getBytes()}. |
| @see org.apache.hadoop.io.WritableComparator#compareBytes(byte[],int,int,byte[],int,int)]]> |
| </doc> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="other" type="byte[]"/> |
| <param name="off" type="int"/> |
| <param name="len" type="int"/> |
| <doc> |
| <![CDATA[Compare bytes from {#getBytes()} to those provided.]]> |
| </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 bytes from {#getBytes()} match.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return a hash of the bytes returned from {#getBytes()}. |
| @see org.apache.hadoop.io.WritableComparator#hashBytes(byte[],int)]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Interface supported by {@link org.apache.hadoop.io.WritableComparable} |
| types supporting ordering/permutation by a representative set of bytes.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BinaryComparable --> |
| <!-- start class org.apache.hadoop.io.BloomMapFile --> |
| <class name="BloomMapFile" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="BloomMapFile" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="delete" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="name" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <field name="BLOOM_FILE_NAME" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <field name="HASH_COUNT" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[This class extends {@link MapFile} and provides very much the same |
| functionality. However, it uses dynamic Bloom filters to provide |
| quick membership test for keys, and it offers a fast version of |
| {@link Reader#get(WritableComparable, Writable)} operation, especially in |
| case of sparsely populated MapFile-s.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BloomMapFile --> |
| <!-- start class org.apache.hadoop.io.BloomMapFile.Reader --> |
| <class name="BloomMapFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration, org.apache.hadoop.io.SequenceFile.Reader.Option[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration, boolean" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <method name="probablyHasKey" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Checks if this MapFile has the indicated key. The membership test is |
| performed using a Bloom filter, so the result has always non-zero |
| probability of false positives. |
| @param key key to check |
| @return false iff key doesn't exist, true if key probably exists. |
| @throws IOException]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Fast version of the |
| {@link MapFile.Reader#get(WritableComparable, Writable)} method. First |
| it checks the Bloom filter for the existence of the key, and only if |
| present it performs the real get operation. This yields significant |
| performance improvements for get operations on sparsely populated files.]]> |
| </doc> |
| </method> |
| <method name="getBloomFilter" return="org.apache.hadoop.util.bloom.Filter" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Retrieve the Bloom filter used by this instance of the Reader. |
| @return a Bloom filter (see {@link Filter})]]> |
| </doc> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.io.BloomMapFile.Reader --> |
| <!-- start class org.apache.hadoop.io.BloomMapFile.Writer --> |
| <class name="BloomMapFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="BloomMapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, org.apache.hadoop.io.SequenceFile.Writer.Option[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <method name="append" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="close" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| </class> |
| <!-- end class org.apache.hadoop.io.BloomMapFile.Writer --> |
| <!-- start class org.apache.hadoop.io.BooleanWritable --> |
| <class name="BooleanWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="BooleanWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="BooleanWritable" type="boolean" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="boolean"/> |
| <doc> |
| <![CDATA[Set the value of the BooleanWritable]]> |
| </doc> |
| </method> |
| <method name="get" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the value of the BooleanWritable]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| </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 WritableComparable for booleans.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BooleanWritable --> |
| <!-- start class org.apache.hadoop.io.BooleanWritable.Comparator --> |
| <class name="BooleanWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="BooleanWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for BooleanWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BooleanWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.BytesWritable --> |
| <class name="BytesWritable" extends="org.apache.hadoop.io.BinaryComparable" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="BytesWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Create a zero-size sequence.]]> |
| </doc> |
| </constructor> |
| <constructor name="BytesWritable" type="byte[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Create a BytesWritable using the byte array as the initial value. |
| @param bytes This array becomes the backing storage for the object.]]> |
| </doc> |
| </constructor> |
| <method name="copyBytes" return="byte[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get a copy of the bytes that is exactly the length of the data. |
| See {@link #getBytes()} for faster access to the underlying array.]]> |
| </doc> |
| </method> |
| <method name="getBytes" return="byte[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the data backing the BytesWritable. Please use {@link #copyBytes()} |
| if you need the returned array to be precisely the length of the data. |
| @return The data is only valid between 0 and getLength() - 1.]]> |
| </doc> |
| </method> |
| <method name="get" return="byte[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use {@link #getBytes()} instead."> |
| <doc> |
| <![CDATA[Get the data from the BytesWritable. |
| @deprecated Use {@link #getBytes()} instead.]]> |
| </doc> |
| </method> |
| <method name="getLength" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the current size of the buffer.]]> |
| </doc> |
| </method> |
| <method name="getSize" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="Use {@link #getLength()} instead."> |
| <doc> |
| <![CDATA[Get the current size of the buffer. |
| @deprecated Use {@link #getLength()} instead.]]> |
| </doc> |
| </method> |
| <method name="setSize" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="size" type="int"/> |
| <doc> |
| <![CDATA[Change the size of the buffer. The values in the old range are preserved |
| and any new values are undefined. The capacity is changed if it is |
| necessary. |
| @param size The new number of bytes]]> |
| </doc> |
| </method> |
| <method name="getCapacity" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Get the capacity, which is the maximum size that could handled without |
| resizing the backing storage. |
| @return The number of bytes]]> |
| </doc> |
| </method> |
| <method name="setCapacity" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="new_cap" type="int"/> |
| <doc> |
| <![CDATA[Change the capacity of the backing storage. |
| The data is preserved. |
| @param new_cap The new capacity in bytes.]]> |
| </doc> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newData" type="org.apache.hadoop.io.BytesWritable"/> |
| <doc> |
| <![CDATA[Set the BytesWritable to the contents of the given newData. |
| @param newData the value to set this BytesWritable to.]]> |
| </doc> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="newData" type="byte[]"/> |
| <param name="offset" type="int"/> |
| <param name="length" type="int"/> |
| <doc> |
| <![CDATA[Set the value to a copy of the given byte range |
| @param newData the new values to copy in |
| @param offset the offset in newData to start at |
| @param length the number of bytes to copy]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="right_obj" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Are the two byte sequences equal?]]> |
| </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[Generate the stream of bytes as hex pairs separated by ' '.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A byte sequence that is usable as a key or value. |
| It is resizable and distinguishes between the size of the seqeunce and |
| the current capacity. The hash function is the front of the md5 of the |
| buffer. The sort order is the same as memcmp.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BytesWritable --> |
| <!-- start class org.apache.hadoop.io.BytesWritable.Comparator --> |
| <class name="BytesWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="BytesWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| <doc> |
| <![CDATA[Compare the buffers in serialized form.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for BytesWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.BytesWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.ByteWritable --> |
| <class name="ByteWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="ByteWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ByteWritable" type="byte" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="byte"/> |
| <doc> |
| <![CDATA[Set the value of this ByteWritable.]]> |
| </doc> |
| </method> |
| <method name="get" return="byte" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the value of this ByteWritable.]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is a ByteWritable with the same value.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compares two ByteWritables.]]> |
| </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 WritableComparable for a single byte.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ByteWritable --> |
| <!-- start class org.apache.hadoop.io.ByteWritable.Comparator --> |
| <class name="ByteWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="ByteWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for ByteWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ByteWritable.Comparator --> |
| <!-- start interface org.apache.hadoop.io.Closeable --> |
| <interface name="Closeable" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="use java.io.Closeable"> |
| <implements name="java.io.Closeable"/> |
| <doc> |
| <![CDATA[@deprecated use java.io.Closeable]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.io.Closeable --> |
| <!-- start class org.apache.hadoop.io.CompressedWritable --> |
| <class name="CompressedWritable" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <constructor name="CompressedWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="ensureInflated" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Must be called by all methods which access fields to ensure that the data |
| has been uncompressed.]]> |
| </doc> |
| </method> |
| <method name="readFieldsCompressed" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Subclasses implement this instead of {@link #readFields(DataInput)}.]]> |
| </doc> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="writeCompressed" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Subclasses implement this instead of {@link #write(DataOutput)}.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A base-class for Writables which store themselves compressed and lazily |
| inflate on field access. This is useful for large objects whose fields are |
| not be altered during a map or reduce operation: leaving the field data |
| compressed makes copying the instance from one file to another much |
| faster.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.CompressedWritable --> |
| <!-- start class org.apache.hadoop.io.DefaultStringifier --> |
| <class name="DefaultStringifier" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Stringifier"/> |
| <constructor name="DefaultStringifier" type="org.apache.hadoop.conf.Configuration, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="fromString" return="T" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="str" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </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="obj" type="T"/> |
| <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> |
| <method name="store" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="item" type="K"/> |
| <param name="keyName" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Stores the item in the configuration with the given keyName. |
| |
| @param <K> the class of the item |
| @param conf the configuration to store |
| @param item the object to be stored |
| @param keyName the name of the key to use |
| @throws IOException : forwards Exceptions from the underlying |
| {@link Serialization} classes.]]> |
| </doc> |
| </method> |
| <method name="load" return="K" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="keyName" type="java.lang.String"/> |
| <param name="itemClass" type="java.lang.Class"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Restores the object from the configuration. |
| |
| @param <K> the class of the item |
| @param conf the configuration to use |
| @param keyName the name of the key to use |
| @param itemClass the class of the item |
| @return restored object |
| @throws IOException : forwards Exceptions from the underlying |
| {@link Serialization} classes.]]> |
| </doc> |
| </method> |
| <method name="storeArray" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="items" type="K[]"/> |
| <param name="keyName" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Stores the array of items in the configuration with the given keyName. |
| |
| @param <K> the class of the item |
| @param conf the configuration to use |
| @param items the objects to be stored |
| @param keyName the name of the key to use |
| @throws IndexOutOfBoundsException if the items array is empty |
| @throws IOException : forwards Exceptions from the underlying |
| {@link Serialization} classes.]]> |
| </doc> |
| </method> |
| <method name="loadArray" return="K[]" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="keyName" type="java.lang.String"/> |
| <param name="itemClass" type="java.lang.Class"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Restores the array of objects from the configuration. |
| |
| @param <K> the class of the item |
| @param conf the configuration to use |
| @param keyName the name of the key to use |
| @param itemClass the class of the item |
| @return restored object |
| @throws IOException : forwards Exceptions from the underlying |
| {@link Serialization} classes.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[DefaultStringifier is the default implementation of the {@link Stringifier} |
| interface which stringifies the objects using base64 encoding of the |
| serialized version of the objects. The {@link Serializer} and |
| {@link Deserializer} are obtained from the {@link SerializationFactory}. |
| <br> |
| DefaultStringifier offers convenience methods to store/load objects to/from |
| the configuration. |
| |
| @param <T> the class of the objects to stringify]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.DefaultStringifier --> |
| <!-- start class org.apache.hadoop.io.DoubleWritable --> |
| <class name="DoubleWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="DoubleWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="DoubleWritable" type="double" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="double"/> |
| </method> |
| <method name="get" return="double" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is a DoubleWritable with the same value.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| </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[Writable for Double values.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.DoubleWritable --> |
| <!-- start class org.apache.hadoop.io.DoubleWritable.Comparator --> |
| <class name="DoubleWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="DoubleWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for DoubleWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.DoubleWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.EnumSetWritable --> |
| <class name="EnumSetWritable" extends="java.util.AbstractCollection" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <implements name="org.apache.hadoop.conf.Configurable"/> |
| <constructor name="EnumSetWritable" type="java.util.EnumSet, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a new EnumSetWritable. If the <tt>value</tt> argument is null or |
| its size is zero, the <tt>elementType</tt> argument must not be null. If |
| the argument <tt>value</tt>'s size is bigger than zero, the argument |
| <tt>elementType</tt> is not be used. |
| |
| @param value |
| @param elementType]]> |
| </doc> |
| </constructor> |
| <constructor name="EnumSetWritable" type="java.util.EnumSet" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a new EnumSetWritable. Argument <tt>value</tt> should not be null |
| or empty. |
| |
| @param value]]> |
| </doc> |
| </constructor> |
| <method name="iterator" return="java.util.Iterator" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="size" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="add" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="e" type="E"/> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="java.util.EnumSet"/> |
| <param name="elementType" type="java.lang.Class"/> |
| <doc> |
| <![CDATA[reset the EnumSetWritable with specified |
| <tt>value</value> and <tt>elementType</tt>. If the <tt>value</tt> argument |
| is null or its size is zero, the <tt>elementType</tt> argument must not be |
| null. If the argument <tt>value</tt>'s size is bigger than zero, the |
| argument <tt>elementType</tt> is not be used. |
| |
| @param value |
| @param elementType]]> |
| </doc> |
| </method> |
| <method name="get" return="java.util.EnumSet" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the value of this EnumSetWritable.]]> |
| </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="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="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true if <code>o</code> is an EnumSetWritable with the same value, |
| or both are null.]]> |
| </doc> |
| </method> |
| <method name="getElementType" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the class of all the elements of the underlying EnumSetWriable. It |
| may return null. |
| |
| @return the element class]]> |
| </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> |
| <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="getConf" return="org.apache.hadoop.conf.Configuration" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </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"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A Writable wrapper for EnumSet.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.EnumSetWritable --> |
| <!-- start class org.apache.hadoop.io.FloatWritable --> |
| <class name="FloatWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="FloatWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="FloatWritable" type="float" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="float"/> |
| <doc> |
| <![CDATA[Set the value of this FloatWritable.]]> |
| </doc> |
| </method> |
| <method name="get" return="float" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the value of this FloatWritable.]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is a FloatWritable with the same value.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compares two FloatWritables.]]> |
| </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 WritableComparable for floats.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.FloatWritable --> |
| <!-- start class org.apache.hadoop.io.FloatWritable.Comparator --> |
| <class name="FloatWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="FloatWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for FloatWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.FloatWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.GenericWritable --> |
| <class name="GenericWritable" extends="java.lang.Object" |
| abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <implements name="org.apache.hadoop.conf.Configurable"/> |
| <constructor name="GenericWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="obj" type="org.apache.hadoop.io.Writable"/> |
| <doc> |
| <![CDATA[Set the instance that is wrapped. |
| |
| @param obj]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the wrapped instance.]]> |
| </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="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="getTypes" return="java.lang.Class[]" |
| abstract="true" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return all classes that may be wrapped. Subclasses should implement this |
| to return a constant array of classes.]]> |
| </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"> |
| </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> |
| <doc> |
| <![CDATA[A wrapper for Writable instances. |
| <p> |
| When two sequence files, which have same Key type but different Value |
| types, are mapped out to reduce, multiple Value types is not allowed. |
| In this case, this class can help you wrap instances with different types. |
| </p> |
| |
| <p> |
| Compared with <code>ObjectWritable</code>, this class is much more effective, |
| because <code>ObjectWritable</code> will append the class declaration as a String |
| into the output file in every Key-Value pair. |
| </p> |
| |
| <p> |
| Generic Writable implements {@link Configurable} interface, so that it will be |
| configured by the framework. The configuration is passed to the wrapped objects |
| implementing {@link Configurable} interface <i>before deserialization</i>. |
| </p> |
| |
| how to use it: <br> |
| 1. Write your own class, such as GenericObject, which extends GenericWritable.<br> |
| 2. Implements the abstract method <code>getTypes()</code>, defines |
| the classes which will be wrapped in GenericObject in application. |
| Attention: this classes defined in <code>getTypes()</code> method, must |
| implement <code>Writable</code> interface. |
| <br><br> |
| |
| The code looks like this: |
| <blockquote><pre> |
| public class GenericObject extends GenericWritable { |
| |
| private static Class[] CLASSES = { |
| ClassType1.class, |
| ClassType2.class, |
| ClassType3.class, |
| }; |
| |
| protected Class[] getTypes() { |
| return CLASSES; |
| } |
| |
| } |
| </pre></blockquote> |
| |
| @since Nov 8, 2006]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.GenericWritable --> |
| <!-- start class org.apache.hadoop.io.IntWritable --> |
| <class name="IntWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="IntWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="IntWritable" type="int" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="int"/> |
| <doc> |
| <![CDATA[Set the value of this IntWritable.]]> |
| </doc> |
| </method> |
| <method name="get" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the value of this IntWritable.]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is a IntWritable with the same value.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compares two IntWritables.]]> |
| </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 WritableComparable for ints.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.IntWritable --> |
| <!-- start class org.apache.hadoop.io.IntWritable.Comparator --> |
| <class name="IntWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="IntWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for IntWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.IntWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.IOUtils --> |
| <class name="IOUtils" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="IOUtils" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="copyBytes" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="out" type="java.io.OutputStream"/> |
| <param name="buffSize" type="int"/> |
| <param name="close" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copies from one stream to another. |
| @param in InputStrem to read from |
| @param out OutputStream to write to |
| @param buffSize the size of the buffer |
| @param close whether or not close the InputStream and |
| OutputStream at the end. The streams are closed in the finally clause.]]> |
| </doc> |
| </method> |
| <method name="copyBytes" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="out" type="java.io.OutputStream"/> |
| <param name="buffSize" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copies from one stream to another. |
| |
| @param in InputStrem to read from |
| @param out OutputStream to write to |
| @param buffSize the size of the buffer]]> |
| </doc> |
| </method> |
| <method name="copyBytes" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="out" type="java.io.OutputStream"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copies from one stream to another. <strong>closes the input and output streams |
| at the end</strong>. |
| @param in InputStrem to read from |
| @param out OutputStream to write to |
| @param conf the Configuration object]]> |
| </doc> |
| </method> |
| <method name="copyBytes" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="out" type="java.io.OutputStream"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="close" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Copies from one stream to another. |
| @param in InputStrem to read from |
| @param out OutputStream to write to |
| @param conf the Configuration object |
| @param close whether or not close the InputStream and |
| OutputStream at the end. The streams are closed in the finally clause.]]> |
| </doc> |
| </method> |
| <method name="readFully" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="buf" type="byte[]"/> |
| <param name="off" type="int"/> |
| <param name="len" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Reads len bytes in a loop. |
| @param in The InputStream to read from |
| @param buf The buffer to fill |
| @param off offset from the buffer |
| @param len the length of bytes to read |
| @throws IOException if it could not read requested number of bytes |
| for any reason (including EOF)]]> |
| </doc> |
| </method> |
| <method name="skipFully" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <param name="len" type="long"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Similar to readFully(). Skips bytes in a loop. |
| @param in The InputStream to skip bytes from |
| @param len number of bytes to skip. |
| @throws IOException if it could not skip requested number of bytes |
| for any reason (including EOF)]]> |
| </doc> |
| </method> |
| <method name="cleanup" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="log" type="org.apache.commons.logging.Log"/> |
| <param name="closeables" type="java.io.Closeable[]"/> |
| <doc> |
| <![CDATA[Close the Closeable objects and <b>ignore</b> any {@link IOException} or |
| null pointers. Must only be used for cleanup in exception handlers. |
| @param log the log to record problems to at debug level. Can be null. |
| @param closeables the objects to close]]> |
| </doc> |
| </method> |
| <method name="closeStream" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="stream" type="java.io.Closeable"/> |
| <doc> |
| <![CDATA[Closes the stream ignoring {@link IOException}. |
| Must only be called in cleaning up from exception handlers. |
| @param stream the Stream to close]]> |
| </doc> |
| </method> |
| <method name="closeSocket" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="sock" type="java.net.Socket"/> |
| <doc> |
| <![CDATA[Closes the socket ignoring {@link IOException} |
| @param sock the Socket to close]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[An utility class for I/O related functionality.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.IOUtils --> |
| <!-- start class org.apache.hadoop.io.IOUtils.NullOutputStream --> |
| <class name="IOUtils.NullOutputStream" extends="java.io.OutputStream" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="IOUtils.NullOutputStream" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="write" |
| 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="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <doc> |
| <![CDATA[/dev/null of OutputStreams.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.IOUtils.NullOutputStream --> |
| <!-- start class org.apache.hadoop.io.LongWritable --> |
| <class name="LongWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="LongWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="LongWritable" type="long" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="long"/> |
| <doc> |
| <![CDATA[Set the value of this LongWritable.]]> |
| </doc> |
| </method> |
| <method name="get" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the value of this LongWritable.]]> |
| </doc> |
| </method> |
| <method name="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is a LongWritable with the same value.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Compares two LongWritables.]]> |
| </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 WritableComparable for longs.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.LongWritable --> |
| <!-- start class org.apache.hadoop.io.LongWritable.Comparator --> |
| <class name="LongWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="LongWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A Comparator optimized for LongWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.LongWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.LongWritable.DecreasingComparator --> |
| <class name="LongWritable.DecreasingComparator" extends="org.apache.hadoop.io.LongWritable.Comparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="LongWritable.DecreasingComparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="a" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="b" type="org.apache.hadoop.io.WritableComparable"/> |
| </method> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A decreasing Comparator optimized for LongWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.LongWritable.DecreasingComparator --> |
| <!-- start class org.apache.hadoop.io.MapFile --> |
| <class name="MapFile" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="MapFile" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="rename" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="oldName" type="java.lang.String"/> |
| <param name="newName" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Renames an existing map directory.]]> |
| </doc> |
| </method> |
| <method name="delete" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="name" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Deletes the named map file.]]> |
| </doc> |
| </method> |
| <method name="fix" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="fs" type="org.apache.hadoop.fs.FileSystem"/> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <param name="keyClass" type="java.lang.Class"/> |
| <param name="valueClass" type="java.lang.Class"/> |
| <param name="dryrun" type="boolean"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="Exception" type="java.lang.Exception"/> |
| <doc> |
| <![CDATA[This method attempts to fix a corrupt MapFile by re-creating its index. |
| @param fs filesystem |
| @param dir directory containing the MapFile data and index |
| @param keyClass key class (has to be a subclass of Writable) |
| @param valueClass value class (has to be a subclass of Writable) |
| @param dryrun do not perform any changes, just report what needs to be done |
| @return number of valid entries in this MapFile, or -1 if no fixing was needed |
| @throws Exception]]> |
| </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"/> |
| </method> |
| <field name="INDEX_FILE_NAME" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The name of the index file.]]> |
| </doc> |
| </field> |
| <field name="DATA_FILE_NAME" type="java.lang.String" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The name of the data file.]]> |
| </doc> |
| </field> |
| <doc> |
| <![CDATA[A file-based map from keys to values. |
| |
| <p>A map is a directory containing two files, the <code>data</code> file, |
| containing all keys and values in the map, and a smaller <code>index</code> |
| file, containing a fraction of the keys. The fraction is determined by |
| {@link Writer#getIndexInterval()}. |
| |
| <p>The index file is read entirely into memory. Thus key implementations |
| should try to keep themselves small. |
| |
| <p>Map files are created by adding entries in-order. To maintain a large |
| database, perform updates by copying the previous version of a database and |
| merging in a sorted change list, to create a new version of the database in |
| a new file. Sorting large change lists can be done with {@link |
| SequenceFile.Sorter}.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MapFile --> |
| <!-- start class org.apache.hadoop.io.MapFile.Reader --> |
| <class name="MapFile.Reader" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.io.Closeable"/> |
| <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration, org.apache.hadoop.io.SequenceFile.Reader.Option[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="deprecated, no comment"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct a map reader for the named map. |
| @deprecated]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Reader" type="org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.conf.Configuration" |
| static="false" final="false" visibility="public" |
| deprecated="deprecated, no comment"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct a map reader for the named map using the named comparator. |
| @deprecated]]> |
| </doc> |
| </constructor> |
| <method name="getKeyClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the class of keys in this file.]]> |
| </doc> |
| </method> |
| <method name="getValueClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the class of values in this file.]]> |
| </doc> |
| </method> |
| <method name="comparator" return="org.apache.hadoop.io.MapFile.Reader.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="org.apache.hadoop.io.WritableComparator"/> |
| </method> |
| <method name="open" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="dir" type="org.apache.hadoop.fs.Path"/> |
| <param name="comparator" type="org.apache.hadoop.io.WritableComparator"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="options" type="org.apache.hadoop.io.SequenceFile.Reader.Option[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="createDataFileReader" return="org.apache.hadoop.io.SequenceFile.Reader" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="protected" |
| deprecated="not deprecated"> |
| <param name="dataFile" type="org.apache.hadoop.fs.Path"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="options" type="org.apache.hadoop.io.SequenceFile.Reader.Option[]"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Override this method to specialize the type of |
| {@link SequenceFile.Reader} returned.]]> |
| </doc> |
| </method> |
| <method name="reset" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Re-positions the reader before its first key.]]> |
| </doc> |
| </method> |
| <method name="midKey" return="org.apache.hadoop.io.WritableComparable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Get the key at approximately the middle of the file. Or null if the |
| file is empty.]]> |
| </doc> |
| </method> |
| <method name="finalKey" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Reads the final key from the file. |
| |
| @param key key to read into]]> |
| </doc> |
| </method> |
| <method name="seek" return="boolean" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Positions the reader at the named key, or if none such exists, at the |
| first entry after the named key. Returns true iff the named key exists |
| in this map.]]> |
| </doc> |
| </method> |
| <method name="next" return="boolean" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read the next key/value pair in the map into <code>key</code> and |
| <code>val</code>. Returns true if such a pair exists and false when at |
| the end of the map]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Return the value for the named key, or null if none exists.]]> |
| </doc> |
| </method> |
| <method name="getClosest" return="org.apache.hadoop.io.WritableComparable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Finds the record that is the closest match to the specified key. |
| Returns <code>key</code> or if it does not exist, at the first entry |
| after the named key. |
| |
| - * @param key - key that we're trying to find |
| - * @param val - data value if key is found |
| - * @return - the key that was the closest match or null if eof.]]> |
| </doc> |
| </method> |
| <method name="getClosest" return="org.apache.hadoop.io.WritableComparable" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <param name="before" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Finds the record that is the closest match to the specified key. |
| |
| @param key - key that we're trying to find |
| @param val - data value if key is found |
| @param before - IF true, and <code>key</code> does not exist, return |
| the first entry that falls just before the <code>key</code>. Otherwise, |
| return the record that sorts just after. |
| @return - the key that was the closest match or null if eof.]]> |
| </doc> |
| </method> |
| <method name="close" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Close the map.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Provide access to an existing map.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MapFile.Reader --> |
| <!-- start interface org.apache.hadoop.io.MapFile.Reader.Option --> |
| <interface name="MapFile.Reader.Option" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.SequenceFile.Reader.Option"/> |
| </interface> |
| <!-- end interface org.apache.hadoop.io.MapFile.Reader.Option --> |
| <!-- start class org.apache.hadoop.io.MapFile.Writer --> |
| <class name="MapFile.Writer" extends="java.lang.Object" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.io.Closeable"/> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map for keys of the named class. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map for keys of the named class. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map for keys of the named class. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map for keys of the named class. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map using the named key comparator. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map using the named key comparator. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...)} instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map using the named key comparator. |
| @deprecated Use Writer(Configuration, Path, Option...)} instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, java.lang.Class, org.apache.hadoop.io.SequenceFile.CompressionType, org.apache.hadoop.io.compress.CompressionCodec, org.apache.hadoop.util.Progressable" |
| static="false" final="false" visibility="public" |
| deprecated="Use Writer(Configuration, Path, Option...) instead."> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Create the named map using the named key comparator. |
| @deprecated Use Writer(Configuration, Path, Option...) instead.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, org.apache.hadoop.io.SequenceFile.Writer.Option[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| </constructor> |
| <method name="keyClass" return="org.apache.hadoop.io.MapFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="java.lang.Class"/> |
| </method> |
| <method name="comparator" return="org.apache.hadoop.io.MapFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="org.apache.hadoop.io.WritableComparator"/> |
| </method> |
| <method name="valueClass" return="org.apache.hadoop.io.SequenceFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="java.lang.Class"/> |
| </method> |
| <method name="compression" return="org.apache.hadoop.io.SequenceFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="type" type="org.apache.hadoop.io.SequenceFile.CompressionType"/> |
| </method> |
| <method name="compression" return="org.apache.hadoop.io.SequenceFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="type" type="org.apache.hadoop.io.SequenceFile.CompressionType"/> |
| <param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/> |
| </method> |
| <method name="progressable" return="org.apache.hadoop.io.SequenceFile.Writer.Option" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="org.apache.hadoop.util.Progressable"/> |
| </method> |
| <method name="getIndexInterval" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[The number of entries that are added before an index entry is added.]]> |
| </doc> |
| </method> |
| <method name="setIndexInterval" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="interval" type="int"/> |
| <doc> |
| <![CDATA[Sets the index interval. |
| @see #getIndexInterval()]]> |
| </doc> |
| </method> |
| <method name="setIndexInterval" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="interval" type="int"/> |
| <doc> |
| <![CDATA[Sets the index interval and stores it in conf |
| @see #getIndexInterval()]]> |
| </doc> |
| </method> |
| <method name="close" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Close the map.]]> |
| </doc> |
| </method> |
| <method name="append" |
| abstract="false" native="false" synchronized="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.WritableComparable"/> |
| <param name="val" type="org.apache.hadoop.io.Writable"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Append a key/value pair to the map. The key must be greater or equal |
| to the previous key added to the map.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Writes a new map.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MapFile.Writer --> |
| <!-- start interface org.apache.hadoop.io.MapFile.Writer.Option --> |
| <interface name="MapFile.Writer.Option" abstract="true" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.SequenceFile.Writer.Option"/> |
| </interface> |
| <!-- end interface org.apache.hadoop.io.MapFile.Writer.Option --> |
| <!-- start class org.apache.hadoop.io.MapWritable --> |
| <class name="MapWritable" extends="org.apache.hadoop.io.AbstractMapWritable" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.util.Map"/> |
| <constructor name="MapWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Default constructor.]]> |
| </doc> |
| </constructor> |
| <constructor name="MapWritable" type="org.apache.hadoop.io.MapWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Copy constructor. |
| |
| @param other the map to copy from]]> |
| </doc> |
| </constructor> |
| <method name="clear" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="containsKey" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="containsValue" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="value" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="entrySet" return="java.util.Set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="get" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="isEmpty" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="keySet" return="java.util.Set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="put" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="org.apache.hadoop.io.Writable"/> |
| <param name="value" type="org.apache.hadoop.io.Writable"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="putAll" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="t" type="java.util.Map"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="remove" return="org.apache.hadoop.io.Writable" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="key" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="size" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </doc> |
| </method> |
| <method name="values" return="java.util.Collection" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[{@inheritDoc}]]> |
| </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> |
| <doc> |
| <![CDATA[A Writable Map.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MapWritable --> |
| <!-- start class org.apache.hadoop.io.MD5Hash --> |
| <class name="MD5Hash" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <constructor name="MD5Hash" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs an MD5Hash.]]> |
| </doc> |
| </constructor> |
| <constructor name="MD5Hash" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs an MD5Hash from a hex string.]]> |
| </doc> |
| </constructor> |
| <constructor name="MD5Hash" type="byte[]" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Constructs an MD5Hash with a specified value.]]> |
| </doc> |
| </constructor> |
| <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="read" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Constructs, reads and returns an instance.]]> |
| </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"/> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="that" type="org.apache.hadoop.io.MD5Hash"/> |
| <doc> |
| <![CDATA[Copy the contents of another instance into this instance.]]> |
| </doc> |
| </method> |
| <method name="getDigest" return="byte[]" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the digest bytes.]]> |
| </doc> |
| </method> |
| <method name="digest" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="data" type="byte[]"/> |
| <doc> |
| <![CDATA[Construct a hash value for a byte array.]]> |
| </doc> |
| </method> |
| <method name="getDigester" return="java.security.MessageDigest" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Create a thread local MD5 digester]]> |
| </doc> |
| </method> |
| <method name="digest" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.InputStream"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Construct a hash value for the content from the InputStream.]]> |
| </doc> |
| </method> |
| <method name="digest" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="data" type="byte[]"/> |
| <param name="start" type="int"/> |
| <param name="len" type="int"/> |
| <doc> |
| <![CDATA[Construct a hash value for a byte array.]]> |
| </doc> |
| </method> |
| <method name="digest" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="string" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Construct a hash value for a String.]]> |
| </doc> |
| </method> |
| <method name="digest" return="org.apache.hadoop.io.MD5Hash" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="utf8" type="org.apache.hadoop.io.UTF8"/> |
| <doc> |
| <![CDATA[Construct a hash value for a String.]]> |
| </doc> |
| </method> |
| <method name="halfDigest" return="long" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Construct a half-sized version of this MD5. Fits in a long]]> |
| </doc> |
| </method> |
| <method name="quarterDigest" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return a 32-bit digest of the MD5. |
| @return the first 4 bytes of the md5]]> |
| </doc> |
| </method> |
| <method name="equals" return="boolean" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="o" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Returns true iff <code>o</code> is an MD5Hash whose digest contains the |
| same values.]]> |
| </doc> |
| </method> |
| <method name="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns a hash code value for this object. |
| Only uses the first 4 bytes, since md5s are evenly distributed.]]> |
| </doc> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="that" type="org.apache.hadoop.io.MD5Hash"/> |
| <doc> |
| <![CDATA[Compares this object with the specified object for order.]]> |
| </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[Returns a string representation of this object.]]> |
| </doc> |
| </method> |
| <method name="setDigest" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="hex" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Sets the digest value from a hex string.]]> |
| </doc> |
| </method> |
| <field name="MD5_LEN" type="int" |
| transient="false" volatile="false" |
| static="true" final="true" visibility="public" |
| deprecated="not deprecated"> |
| </field> |
| <doc> |
| <![CDATA[A Writable for MD5 hash values.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MD5Hash --> |
| <!-- start class org.apache.hadoop.io.MD5Hash.Comparator --> |
| <class name="MD5Hash.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="MD5Hash.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[A WritableComparator optimized for MD5Hash keys.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MD5Hash.Comparator --> |
| <!-- start class org.apache.hadoop.io.MultipleIOException --> |
| <class name="MultipleIOException" extends="java.io.IOException" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <method name="getExceptions" return="java.util.List" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[@return the underlying exceptions]]> |
| </doc> |
| </method> |
| <method name="createIOException" return="java.io.IOException" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="exceptions" type="java.util.List"/> |
| <doc> |
| <![CDATA[A convenient method to create an {@link IOException}.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[Encapsulate a list of {@link IOException} into an {@link IOException}]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.MultipleIOException --> |
| <!-- start class org.apache.hadoop.io.NullWritable --> |
| <class name="NullWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.WritableComparable"/> |
| <method name="get" return="org.apache.hadoop.io.NullWritable" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Returns the single instance of this class.]]> |
| </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="hashCode" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </method> |
| <method name="compareTo" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="other" type="java.lang.Object"/> |
| </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"/> |
| </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[Singleton Writable with no data.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.NullWritable --> |
| <!-- start class org.apache.hadoop.io.NullWritable.Comparator --> |
| <class name="NullWritable.Comparator" extends="org.apache.hadoop.io.WritableComparator" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="NullWritable.Comparator" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| <doc> |
| <![CDATA[Compare the buffers in serialized form.]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[A Comparator "optimized" for NullWritable.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.NullWritable.Comparator --> |
| <!-- start class org.apache.hadoop.io.ObjectWritable --> |
| <class name="ObjectWritable" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="org.apache.hadoop.io.Writable"/> |
| <implements name="org.apache.hadoop.conf.Configurable"/> |
| <constructor name="ObjectWritable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ObjectWritable" type="java.lang.Object" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="ObjectWritable" type="java.lang.Class, java.lang.Object" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="get" return="java.lang.Object" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the instance, or null if none.]]> |
| </doc> |
| </method> |
| <method name="getDeclaredClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <doc> |
| <![CDATA[Return the class this is meant to be.]]> |
| </doc> |
| </method> |
| <method name="set" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="instance" type="java.lang.Object"/> |
| <doc> |
| <![CDATA[Reset the instance.]]> |
| </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="readFields" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="write" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| </method> |
| <method name="writeObject" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <param name="instance" type="java.lang.Object"/> |
| <param name="declaredClass" type="java.lang.Class"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Write a {@link Writable}, {@link String}, primitive type, or an array of |
| the preceding.]]> |
| </doc> |
| </method> |
| <method name="writeObject" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="out" type="java.io.DataOutput"/> |
| <param name="instance" type="java.lang.Object"/> |
| <param name="declaredClass" type="java.lang.Class"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="allowCompactArrays" type="boolean"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Write a {@link Writable}, {@link String}, primitive type, or an array of |
| the preceding. |
| |
| @param allowCompactArrays - set true for RPC and internal or intra-cluster |
| usages. Set false for inter-cluster, File, and other persisted output |
| usages, to preserve the ability to interchange files with other clusters |
| that may not be running the same version of software. Sometime in ~2013 |
| we can consider removing this parameter and always using the compact format.]]> |
| </doc> |
| </method> |
| <method name="readObject" return="java.lang.Object" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of |
| the preceding.]]> |
| </doc> |
| </method> |
| <method name="readObject" return="java.lang.Object" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="in" type="java.io.DataInput"/> |
| <param name="objectWritable" type="org.apache.hadoop.io.ObjectWritable"/> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Read a {@link Writable}, {@link String}, primitive type, or an array of |
| the preceding.]]> |
| </doc> |
| </method> |
| <method name="loadClass" return="java.lang.Class" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="conf" type="org.apache.hadoop.conf.Configuration"/> |
| <param name="className" type="java.lang.String"/> |
| <doc> |
| <![CDATA[Find and load the class with given name <tt>className</tt> by first finding |
| it in the specified <tt>conf</tt>. If the specified <tt>conf</tt> is null, |
| try load it directly.]]> |
| </doc> |
| </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="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[A polymorphic Writable that writes an instance with it's class name. |
| Handles arrays, strings and primitive types without a Writable wrapper.]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.ObjectWritable --> |
| <!-- start interface org.apache.hadoop.io.RawComparator --> |
| <interface name="RawComparator" abstract="true" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <implements name="java.util.Comparator"/> |
| <method name="compare" return="int" |
| abstract="false" native="false" synchronized="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="b1" type="byte[]"/> |
| <param name="s1" type="int"/> |
| <param name="l1" type="int"/> |
| <param name="b2" type="byte[]"/> |
| <param name="s2" type="int"/> |
| <param name="l2" type="int"/> |
| </method> |
| <doc> |
| <![CDATA[<p> |
| A {@link Comparator} that operates directly on byte representations of |
| objects. |
| </p> |
| @param <T> |
| @see DeserializerComparator]]> |
| </doc> |
| </interface> |
| <!-- end interface org.apache.hadoop.io.RawComparator --> |
| <!-- start class org.apache.hadoop.io.SecureIOUtils --> |
| <class name="SecureIOUtils" extends="java.lang.Object" |
| abstract="false" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="SecureIOUtils" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <method name="openForRead" return="java.io.FileInputStream" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="java.io.File"/> |
| <param name="expectedOwner" type="java.lang.String"/> |
| <param name="expectedGroup" type="java.lang.String"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Open the given File for read access, verifying the expected user/group |
| constraints if security is enabled. |
| |
| Note that this function provides no additional checks if Hadoop |
| security is disabled, since doing the checks would be too expensive |
| when native libraries are not available. |
| |
| @param f the file that we are trying to open |
| @param expectedOwner the expected user owner for the file |
| @param expectedGroup the expected group owner for the file |
| @throws IOException if an IO Error occurred, or security is enabled and |
| the user/group does not match]]> |
| </doc> |
| </method> |
| <method name="createForWrite" return="java.io.FileOutputStream" |
| abstract="false" native="false" synchronized="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <param name="f" type="java.io.File"/> |
| <param name="permissions" type="int"/> |
| <exception name="IOException" type="java.io.IOException"/> |
| <doc> |
| <![CDATA[Open the specified File for write access, ensuring that it does not exist. |
| @param f the file that we want to create |
| @param permissions we want to have on the file (if security is enabled) |
| |
| @throws AlreadyExistsException if the file already exists |
| @throws IOException if any other error occurred]]> |
| </doc> |
| </method> |
| <doc> |
| <![CDATA[This class provides secure APIs for opening and creating files on the local |
| disk. The main issue this class tries to handle is that of symlink traversal. |
| <br/> |
| An example of such an attack is: |
| <ol> |
| <li> Malicious user removes his task's syslog file, and puts a link to the |
| jobToken file of a target user.</li> |
| <li> Malicious user tries to open the syslog file via the servlet on the |
| tasktracker.</li> |
| <li> The tasktracker is unaware of the symlink, and simply streams the contents |
| of the jobToken file. The malicious user can now access potentially sensitive |
| map outputs, etc. of the target user's job.</li> |
| </ol> |
| A similar attack is possible involving task log truncation, but in that case |
| due to an insecure write to a file. |
| <br/>]]> |
| </doc> |
| </class> |
| <!-- end class org.apache.hadoop.io.SecureIOUtils --> |
| <!-- start class org.apache.hadoop.io.SecureIOUtils.AlreadyExistsException --> |
| <class name="SecureIOUtils.AlreadyExistsException" extends="java.io.IOException" |
| abstract="false" |
| static="true" final="false" visibility="public" |
| deprecated="not deprecated"> |
| <constructor name="SecureIOUtils.AlreadyExistsException" type="java.lang.String" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <constructor name="SecureIOUtils.AlreadyExistsException" type="java.lang.Throwable" |
| static="false" final="false" visibility="public" |
| deprecated="not deprecated"> |
| </constructor> |
| <doc> |
| <![CDATA[Signals that an attempt to create a file at a given pathname has failed |
| because another file already existed at that path.]]> |
| </doc> |
|