25945 lines
1.1 MiB
XML
25945 lines
1.1 MiB
XML
|
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
|
||
|
|
<!-- Generated by the JDiff Javadoc doclet -->
|
||
|
|
<!-- (http://www.jdiff.org) -->
|
||
|
|
<!-- on Tue Aug 24 10:42:16 PDT 2010 -->
|
||
|
|
|
||
|
|
<api
|
||
|
|
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
|
||
|
|
xsi:noNamespaceSchemaLocation='api.xsd'
|
||
|
|
name="hadoop-core 0.21.0"
|
||
|
|
jdversion="1.0.9">
|
||
|
|
|
||
|
|
<!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/tom/workspace/hadoop-common-0.21-committer/build/hadoop-common-0.21.0.jar:/Users/tom/workspace/hadoop-common-0.21-committer/build/ivy/lib/Hadoop-Common/jdiff/jdiff-1.0.9.jar -classpath /Users/tom/workspace/hadoop-common-0.21-committer/build/classes:/Users/tom/workspace/hadoop-common-0.21-committer/conf:/Users/tom/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar:/Users/tom/.ivy2/cache/log4j/log4j/jars/log4j-1.2.15.jar:/Users/tom/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.1.jar:/Users/tom/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.4.jar:/Users/tom/.ivy2/cache/commons-cli/commons-cli/jars/commons-cli-1.2.jar:/Users/tom/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/Users/tom/.ivy2/cache/net.java.dev.jets3t/jets3t/jars/jets3t-0.7.1.jar:/Users/tom/.ivy2/cache/commons-net/commons-net/jars/commons-net-1.4.1.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/servlet-api-2.5/jars/servlet-api-2.5-6.1.14.jar:/Users/tom/.ivy2/cache/net.sf.kosmosfs/kfs/jars/kfs-0.3.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.14.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.14.jar:/Users/tom/.ivy2/cache/tomcat/jasper-runtime/jars/jasper-runtime-5.5.12.jar:/Users/tom/.ivy2/cache/tomcat/jasper-compiler/jars/jasper-compiler-5.5.12.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jsp-api-2.1/jars/jsp-api-2.1-6.1.14.jar:/Users/tom/.ivy2/cache/org.mortbay.jetty/jsp-2.1/jars/jsp-2.1-6.1.14.jar:/Users/tom/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/Users/tom/.ivy2/cache/oro/oro/jars/oro-2.0.8.jar:/Users/tom/.ivy2/cache/jdiff/jdiff/jars/jdiff-1.0.9.jar:/Users/tom/.ivy2/cache/junit/junit/jars/junit-4.8.1.jar:/Users/tom/.ivy2/cache/hsqldb/hsqldb/jars/hsqldb-1.8.0.10.jar:/Users/tom/.ivy2/cache/commons-logging/commons-logging-api/jars/commons-logging-api-1.1.jar:/Users/tom/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.5.11.jar:/Users/tom/.ivy2/cache/org.eclipse.jdt/core/jars/core-3.1.1.jar:/Users/tom/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.5.11.jar:/Users/tom/.ivy2/cache/org.apache.hadoop/avro/jars/avro-1.3.2.jar:/Users/tom/.ivy2/cache/org.codehaus.jackson/jackson-mapper-asl/jars/jackson-mapper-asl-1.4.2.jar:/Users/tom/.ivy2/cache/org.codehaus.jackson/jackson-core-asl/jars/jackson-core-asl-1.4.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer/jars/paranamer-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer-ant/jars/paranamer-ant-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.paranamer/paranamer-generator/jars/paranamer-generator-2.2.jar:/Users/tom/.ivy2/cache/com.thoughtworks.qdox/qdox/jars/qdox-1.10.1.jar:/Users/tom/.ivy2/cache/asm/asm/jars/asm-3.2.jar:/Users/tom/.ivy2/cache/commons-lang/commons-lang/jars/commons-lang-2.5.jar:/Users/tom/.ivy2/cache/org.aspectj/aspectjrt/jars/aspectjrt-1.6.5.jar:/Users/tom/.ivy2/cache/org.aspectj/aspectjtools/jars/aspectjtools-1.6.5.jar:/Users/tom/.ivy2/cache/org.mockito/mockito-all/jars/mockito-all-1.8.2.jar:/usr/share/ant/lib/ant-launcher.jar:/Users/tom/.ant/lib/ivy.jar:/usr/share/ant/lib/ant-antlr.jar:/usr/share/ant/lib/ant-jai.jar:/usr/share/ant/lib/ant-jmf.jar:/usr/share/ant/lib/ant-junit.jar:/usr/share/ant/lib/ant-nodeps.jar:/usr/share/ant/lib/ant-swing.jar:/usr/share/ant/lib/ant-testutil.jar:/usr/share/ant/lib/ant-trax.jar:/usr/share/ant/lib/ant.jar:/usr/share/ant/lib/ivy-2.1.0.jar:/usr/share/ant/lib/xercesImpl.jar:/usr/share/ant/lib/xml-apis.jar -sourcepath /Users/tom/workspace/hadoop-common-0.21-committer/src/java -apidir /Users/tom/workspace/hadoop-common-0.21-committer/lib/jdiff -apiname hadoop-core 0.21.0 -->
|
||
|
|
<package name="org.apache.hadoop">
|
||
|
|
<!-- start class org.apache.hadoop.HadoopIllegalArgumentException -->
|
||
|
|
<class name="HadoopIllegalArgumentException" extends="java.lang.IllegalArgumentException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="HadoopIllegalArgumentException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructs exception with the specified detail message.
|
||
|
|
@param message detailed message.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Indicates that a method has been passed illegal or invalid argument. This
|
||
|
|
exception is thrown instead of IllegalArgumentException to differentiate the
|
||
|
|
exception thrown in Hadoop implementation from the one thrown in JDK.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.HadoopIllegalArgumentException -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.classification">
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceAudience -->
|
||
|
|
<class name="InterfaceAudience" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Annotation to inform users of a package, class or method's intended audience.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceAudience -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate -->
|
||
|
|
<class name="InterfaceAudience.LimitedPrivate" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Intended only for the project(s) specified in the annotation.
|
||
|
|
For example, "Common", "HDFS", "MapReduce", "ZooKeeper", "HBase".]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceAudience.Private -->
|
||
|
|
<class name="InterfaceAudience.Private" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Intended for use only within Hadoop itself.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceAudience.Private -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceAudience.Public -->
|
||
|
|
<class name="InterfaceAudience.Public" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Intended for use by any project or application.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceAudience.Public -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceStability -->
|
||
|
|
<class name="InterfaceStability" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="InterfaceStability"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Annotation to inform users of how much to rely on a particular package,
|
||
|
|
class or method not changing over time.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceStability -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceStability.Evolving -->
|
||
|
|
<class name="InterfaceStability.Evolving" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Evolving, but can break compatibility at minor release (i.e. m.x)]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceStability.Evolving -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceStability.Stable -->
|
||
|
|
<class name="InterfaceStability.Stable" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Can evolve while retaining compatibility for minor release boundaries.;
|
||
|
|
can break compatibility only at major release (ie. at m.0).]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceStability.Stable -->
|
||
|
|
<!-- start class org.apache.hadoop.classification.InterfaceStability.Unstable -->
|
||
|
|
<class name="InterfaceStability.Unstable" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.annotation.Annotation"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[No guarantee is provided as to reliability or stability across any
|
||
|
|
level of release granularity.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.classification.InterfaceStability.Unstable -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.conf">
|
||
|
|
<!-- start interface org.apache.hadoop.conf.Configurable -->
|
||
|
|
<interface name="Configurable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="setConf"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the configuration to be used by this object.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the configuration used by this object.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Something that may be configured with a {@link Configuration}.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.conf.Configurable -->
|
||
|
|
<!-- start class org.apache.hadoop.conf.Configuration -->
|
||
|
|
<class name="Configuration" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.Iterable"/>
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A new configuration.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Configuration" type="boolean"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A new configuration where the behavior of reading from the default
|
||
|
|
resources can be turned off.
|
||
|
|
|
||
|
|
If the parameter {@code loadDefaults} is false, the new instance
|
||
|
|
will not load resources from the default files.
|
||
|
|
@param loadDefaults specifies whether to load from the default files]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Configuration" type="org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A new configuration with the same settings cloned from another.
|
||
|
|
|
||
|
|
@param other the configuration from which to clone settings.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="addDeprecation"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="java.lang.String"/>
|
||
|
|
<param name="newKeys" type="java.lang.String[]"/>
|
||
|
|
<param name="customMessage" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds the deprecated key to the deprecation map.
|
||
|
|
It does not override any existing entries in the deprecation map.
|
||
|
|
This is to be used only by the developers in order to add deprecation of
|
||
|
|
keys, and attempts to call this method after loading resources once,
|
||
|
|
would lead to <tt>UnsupportedOperationException</tt>
|
||
|
|
@param key
|
||
|
|
@param newKeys
|
||
|
|
@param customMessage]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addDeprecation"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="java.lang.String"/>
|
||
|
|
<param name="newKeys" type="java.lang.String[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds the deprecated key to the deprecation map when no custom message
|
||
|
|
is provided.
|
||
|
|
It does not override any existing entries in the deprecation map.
|
||
|
|
This is to be used only by the developers in order to add deprecation of
|
||
|
|
keys, and attempts to call this method after loading resources once,
|
||
|
|
would lead to <tt>UnsupportedOperationException</tt>
|
||
|
|
|
||
|
|
@param key Key that is to be deprecated
|
||
|
|
@param newKeys list of keys that take up the values of deprecated key]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addDefaultResource"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a default resource. Resources are loaded in the order of the resources
|
||
|
|
added.
|
||
|
|
@param name file name. File should be present in the classpath.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addResource"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a configuration resource.
|
||
|
|
|
||
|
|
The properties of this resource will override properties of previously
|
||
|
|
added resources, unless they were marked <a href="#Final">final</a>.
|
||
|
|
|
||
|
|
@param name resource to be added, the classpath is examined for a file
|
||
|
|
with that name.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addResource"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="url" type="java.net.URL"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a configuration resource.
|
||
|
|
|
||
|
|
The properties of this resource will override properties of previously
|
||
|
|
added resources, unless they were marked <a href="#Final">final</a>.
|
||
|
|
|
||
|
|
@param url url of the resource to be added, the local filesystem is
|
||
|
|
examined directly to find the resource, without referring to
|
||
|
|
the classpath.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addResource"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="file" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a configuration resource.
|
||
|
|
|
||
|
|
The properties of this resource will override properties of previously
|
||
|
|
added resources, unless they were marked <a href="#Final">final</a>.
|
||
|
|
|
||
|
|
@param file file-path of resource to be added, the local filesystem is
|
||
|
|
examined directly to find the resource, without referring to
|
||
|
|
the classpath.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addResource"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a configuration resource.
|
||
|
|
|
||
|
|
The properties of this resource will override properties of previously
|
||
|
|
added resources, unless they were marked <a href="#Final">final</a>.
|
||
|
|
|
||
|
|
@param in InputStream to deserialize the object from.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="reloadConfiguration"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reload configuration from previously added resources.
|
||
|
|
|
||
|
|
This method will clear all the configuration read from the added
|
||
|
|
resources, and final parameters. This will make the resources to
|
||
|
|
be read again before accessing the values. Values that are added
|
||
|
|
via set methods will overlay values read from the resources.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="get" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property, <code>null</code> if
|
||
|
|
no such property exists. If the key is deprecated, it returns the value of
|
||
|
|
the first key which replaces the deprecated key and is not null
|
||
|
|
|
||
|
|
Values are processed for <a href="#VariableExpansion">variable expansion</a>
|
||
|
|
before being returned.
|
||
|
|
|
||
|
|
@param name the property name.
|
||
|
|
@return the value of the <code>name</code> or its replacing property,
|
||
|
|
or null if no such property exists.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getRaw" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property, without doing
|
||
|
|
<a href="#VariableExpansion">variable expansion</a>.If the key is
|
||
|
|
deprecated, it returns the value of the first key which replaces
|
||
|
|
the deprecated key and is not null.
|
||
|
|
|
||
|
|
@param name the property name.
|
||
|
|
@return the value of the <code>name</code> property or
|
||
|
|
its replacing property and null if no such property exists.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the <code>value</code> of the <code>name</code> property. If
|
||
|
|
<code>name</code> is deprecated, it sets the <code>value</code> to the keys
|
||
|
|
that replace the deprecated key.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param value property value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setIfUnset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets a property if it is currently unset.
|
||
|
|
@param name the property name
|
||
|
|
@param value the new value]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="get" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code>. If the key is deprecated,
|
||
|
|
it returns the value of the first key which replaces the deprecated key
|
||
|
|
and is not null.
|
||
|
|
If no such property exists,
|
||
|
|
then <code>defaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value, or <code>defaultValue</code> if the property
|
||
|
|
doesn't exist.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as an <code>int</code>.
|
||
|
|
|
||
|
|
If no such property exists, or if the specified value is not a valid
|
||
|
|
<code>int</code>, then <code>defaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as an <code>int</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to an <code>int</code>.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param value <code>int</code> value of the property.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>long</code>.
|
||
|
|
If no such property is specified, or if the specified value is not a valid
|
||
|
|
<code>long</code>, then <code>defaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as a <code>long</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to a <code>long</code>.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param value <code>long</code> value of the property.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="float"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>float</code>.
|
||
|
|
If no such property is specified, or if the specified value is not a valid
|
||
|
|
<code>float</code>, then <code>defaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as a <code>float</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setFloat"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="float"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to a <code>float</code>.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param value property value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getBoolean" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>boolean</code>.
|
||
|
|
If no such property is specified, or if the specified value is not a valid
|
||
|
|
<code>boolean</code>, then <code>defaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as a <code>boolean</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setBoolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to a <code>boolean</code>.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param value <code>boolean</code> value of the property.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setBooleanIfUnset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the given property, if it is currently unset.
|
||
|
|
@param name property name
|
||
|
|
@param value new value]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setEnum"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="value" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to the given type. This
|
||
|
|
is equivalent to <code>set(<name>, value.toString())</code>.
|
||
|
|
@param name property name
|
||
|
|
@param value new value]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getEnum" return="T"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return value matching this enumerated type.
|
||
|
|
@param name Property name
|
||
|
|
@param defaultValue Value returned if no mapping exists
|
||
|
|
@throws IllegalArgumentException If mapping is illegal for the type
|
||
|
|
provided]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getPattern" return="java.util.regex.Pattern"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.util.regex.Pattern"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>Pattern</code>.
|
||
|
|
If no such property is specified, or if the specified value is not a valid
|
||
|
|
<code>Pattern</code>, then <code>DefaultValue</code> is returned.
|
||
|
|
|
||
|
|
@param name property name
|
||
|
|
@param defaultValue default value
|
||
|
|
@return property value as a compiled Pattern, or defaultValue]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setPattern"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="pattern" type="java.util.regex.Pattern"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the given property to <code>Pattern</code>.
|
||
|
|
If the pattern is passed as null, sets the empty pattern which results in
|
||
|
|
further calls to getPattern(...) returning the default value.
|
||
|
|
|
||
|
|
@param name property name
|
||
|
|
@param pattern new value]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse the given attribute as a set of integer ranges
|
||
|
|
@param name the attribute name
|
||
|
|
@param defaultValue the default value if it is not set
|
||
|
|
@return a new set of ranges from the configured value]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getStringCollection" return="java.util.Collection"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
a collection of <code>String</code>s.
|
||
|
|
If no such property is specified then empty collection is returned.
|
||
|
|
<p>
|
||
|
|
This is an optimized version of {@link #getStrings(String)}
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@return property value as a collection of <code>String</code>s.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getStrings" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
an array of <code>String</code>s.
|
||
|
|
If no such property is specified then <code>null</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@return property value as an array of <code>String</code>s,
|
||
|
|
or <code>null</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getStrings" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.String[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
an array of <code>String</code>s.
|
||
|
|
If no such property is specified then default value is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue The default value
|
||
|
|
@return property value as an array of <code>String</code>s,
|
||
|
|
or default value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTrimmedStringCollection" return="java.util.Collection"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
a collection of <code>String</code>s, trimmed of the leading and trailing whitespace.
|
||
|
|
If no such property is specified then empty <code>Collection</code> is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@return property value as a collection of <code>String</code>s, or empty <code>Collection</code>]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTrimmedStrings" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
|
||
|
|
If no such property is specified then an empty array is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@return property value as an array of trimmed <code>String</code>s,
|
||
|
|
or empty array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTrimmedStrings" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.String[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the comma delimited values of the <code>name</code> property as
|
||
|
|
an array of <code>String</code>s, trimmed of the leading and trailing whitespace.
|
||
|
|
If no such property is specified then default value is returned.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param defaultValue The default value
|
||
|
|
@return property value as an array of trimmed <code>String</code>s,
|
||
|
|
or default value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setStrings"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="values" type="java.lang.String[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the array of string values for the <code>name</code> property as
|
||
|
|
as comma delimited values.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param values The values]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClassByName" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Load a class by name.
|
||
|
|
|
||
|
|
@param name the class name.
|
||
|
|
@return the class object.
|
||
|
|
@throws ClassNotFoundException if the class is not found.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClasses" return="java.lang.Class[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.Class[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property
|
||
|
|
as an array of <code>Class</code>.
|
||
|
|
The value of the property specifies a list of comma separated class names.
|
||
|
|
If no such property is specified, then <code>defaultValue</code> is
|
||
|
|
returned.
|
||
|
|
|
||
|
|
@param name the property name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as a <code>Class[]</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClass" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>.
|
||
|
|
If no such property is specified, then <code>defaultValue</code> is
|
||
|
|
returned.
|
||
|
|
|
||
|
|
@param name the class name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@return property value as a <code>Class</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClass" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="defaultValue" type="java.lang.Class"/>
|
||
|
|
<param name="xface" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>Class</code>
|
||
|
|
implementing the interface specified by <code>xface</code>.
|
||
|
|
|
||
|
|
If no such property is specified, then <code>defaultValue</code> is
|
||
|
|
returned.
|
||
|
|
|
||
|
|
An exception is thrown if the returned class does not implement the named
|
||
|
|
interface.
|
||
|
|
|
||
|
|
@param name the class name.
|
||
|
|
@param defaultValue default value.
|
||
|
|
@param xface the interface implemented by the named class.
|
||
|
|
@return property value as a <code>Class</code>,
|
||
|
|
or <code>defaultValue</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getInstances" return="java.util.List"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="xface" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the value of the <code>name</code> property as a <code>List</code>
|
||
|
|
of objects implementing the interface specified by <code>xface</code>.
|
||
|
|
|
||
|
|
An exception is thrown if any of the classes does not exist, or if it does
|
||
|
|
not implement the named interface.
|
||
|
|
|
||
|
|
@param name the property name.
|
||
|
|
@param xface the interface implemented by the classes named by
|
||
|
|
<code>name</code>.
|
||
|
|
@return a <code>List</code> of objects implementing <code>xface</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setClass"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="theClass" type="java.lang.Class"/>
|
||
|
|
<param name="xface" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the value of the <code>name</code> property to the name of a
|
||
|
|
<code>theClass</code> implementing the given interface <code>xface</code>.
|
||
|
|
|
||
|
|
An exception is thrown if <code>theClass</code> does not implement the
|
||
|
|
interface <code>xface</code>.
|
||
|
|
|
||
|
|
@param name property name.
|
||
|
|
@param theClass property value.
|
||
|
|
@param xface the interface implemented by the named class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLocalPath" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dirsProp" type="java.lang.String"/>
|
||
|
|
<param name="path" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a local file under a directory named by <i>dirsProp</i> with
|
||
|
|
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
|
||
|
|
then one is chosen based on <i>path</i>'s hash code. If the selected
|
||
|
|
directory does not exist, an attempt is made to create it.
|
||
|
|
|
||
|
|
@param dirsProp directory in which to locate the file.
|
||
|
|
@param path file-path.
|
||
|
|
@return local file under the directory with the given path.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFile" return="java.io.File"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dirsProp" type="java.lang.String"/>
|
||
|
|
<param name="path" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a local file name under a directory named in <i>dirsProp</i> with
|
||
|
|
the given <i>path</i>. If <i>dirsProp</i> contains multiple directories,
|
||
|
|
then one is chosen based on <i>path</i>'s hash code. If the selected
|
||
|
|
directory does not exist, an attempt is made to create it.
|
||
|
|
|
||
|
|
@param dirsProp directory in which to locate the file.
|
||
|
|
@param path file-path.
|
||
|
|
@return local file under the directory with the given path.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getResource" return="java.net.URL"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the {@link URL} for the named resource.
|
||
|
|
|
||
|
|
@param name resource name.
|
||
|
|
@return the url for the named resource.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getConfResourceAsInputStream" return="java.io.InputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get an input stream attached to the configuration resource with the
|
||
|
|
given <code>name</code>.
|
||
|
|
|
||
|
|
@param name configuration resource name.
|
||
|
|
@return an input stream attached to the resource.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getConfResourceAsReader" return="java.io.Reader"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a {@link Reader} attached to the configuration resource with the
|
||
|
|
given <code>name</code>.
|
||
|
|
|
||
|
|
@param name configuration resource name.
|
||
|
|
@return a reader attached to the resource.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getProps" return="java.util.Properties"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="size" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the number of keys in the configuration.
|
||
|
|
|
||
|
|
@return number of keys in the configuration.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="clear"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Clears all keys from the configuration.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="iterator" return="java.util.Iterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get an {@link Iterator} to go through the list of <code>String</code>
|
||
|
|
key-value pairs in the configuration.
|
||
|
|
|
||
|
|
@return an iterator over the entries.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeXml"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.OutputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write out the non-default properties in this configuration to the given
|
||
|
|
{@link OutputStream}.
|
||
|
|
|
||
|
|
@param out the output stream to write to.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeXml"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.Writer"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write out the non-default properties in this configuration to the given
|
||
|
|
{@link Writer}.
|
||
|
|
|
||
|
|
@param out the writer to write to.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="dumpConfiguration"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="config" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="out" type="java.io.Writer"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Writes out all the parameters and their properties (final and resource) to
|
||
|
|
the given {@link Writer}
|
||
|
|
The format of the output would be
|
||
|
|
{ "properties" : [ {key1,value1,key1.isFinal,key1.resource}, {key2,value2,
|
||
|
|
key2.isFinal,key2.resource}... ] }
|
||
|
|
It does not output the parameters of the configuration object which is
|
||
|
|
loaded from an input stream.
|
||
|
|
@param out the Writer to write to
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClassLoader" return="java.lang.ClassLoader"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the {@link ClassLoader} for this job.
|
||
|
|
|
||
|
|
@return the correct class loader.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setClassLoader"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="classLoader" type="java.lang.ClassLoader"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the class loader that will be used to load the various objects.
|
||
|
|
|
||
|
|
@param classLoader the new class loader.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="setQuietMode"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="quietmode" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the quietness-mode.
|
||
|
|
|
||
|
|
In the quiet-mode, error and informational messages might not be logged.
|
||
|
|
|
||
|
|
@param quietmode <code>true</code> to set quiet-mode on, <code>false</code>
|
||
|
|
to turn it off.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="main"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="args" type="java.lang.String[]"/>
|
||
|
|
<exception name="Exception" type="java.lang.Exception"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[For debugging. List non-default properties to the terminal and exit.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readFields"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.DataInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="write"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Provides access to configuration parameters.
|
||
|
|
|
||
|
|
<h4 id="Resources">Resources</h4>
|
||
|
|
|
||
|
|
<p>Configurations are specified by resources. A resource contains a set of
|
||
|
|
name/value pairs as XML data. Each resource is named by either a
|
||
|
|
<code>String</code> or by a {@link Path}. If named by a <code>String</code>,
|
||
|
|
then the classpath is examined for a file with that name. If named by a
|
||
|
|
<code>Path</code>, then the local filesystem is examined directly, without
|
||
|
|
referring to the classpath.
|
||
|
|
|
||
|
|
<p>Unless explicitly turned off, Hadoop by default specifies two
|
||
|
|
resources, loaded in-order from the classpath: <ol>
|
||
|
|
<li><tt><a href="{@docRoot}/../core-default.html">core-default.xml</a>
|
||
|
|
</tt>: Read-only defaults for hadoop.</li>
|
||
|
|
<li><tt>core-site.xml</tt>: Site-specific configuration for a given hadoop
|
||
|
|
installation.</li>
|
||
|
|
</ol>
|
||
|
|
Applications may add additional resources, which are loaded
|
||
|
|
subsequent to these resources in the order they are added.
|
||
|
|
|
||
|
|
<h4 id="FinalParams">Final Parameters</h4>
|
||
|
|
|
||
|
|
<p>Configuration parameters may be declared <i>final</i>.
|
||
|
|
Once a resource declares a value final, no subsequently-loaded
|
||
|
|
resource can alter that value.
|
||
|
|
For example, one might define a final parameter with:
|
||
|
|
<tt><pre>
|
||
|
|
<property>
|
||
|
|
<name>dfs.client.buffer.dir</name>
|
||
|
|
<value>/tmp/hadoop/dfs/client</value>
|
||
|
|
<b><final>true</final></b>
|
||
|
|
</property></pre></tt>
|
||
|
|
|
||
|
|
Administrators typically define parameters as final in
|
||
|
|
<tt>core-site.xml</tt> for values that user applications may not alter.
|
||
|
|
|
||
|
|
<h4 id="VariableExpansion">Variable Expansion</h4>
|
||
|
|
|
||
|
|
<p>Value strings are first processed for <i>variable expansion</i>. The
|
||
|
|
available properties are:<ol>
|
||
|
|
<li>Other properties defined in this Configuration; and, if a name is
|
||
|
|
undefined here,</li>
|
||
|
|
<li>Properties in {@link System#getProperties()}.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<p>For example, if a configuration resource contains the following property
|
||
|
|
definitions:
|
||
|
|
<tt><pre>
|
||
|
|
<property>
|
||
|
|
<name>basedir</name>
|
||
|
|
<value>/user/${<i>user.name</i>}</value>
|
||
|
|
</property>
|
||
|
|
|
||
|
|
<property>
|
||
|
|
<name>tempdir</name>
|
||
|
|
<value>${<i>basedir</i>}/tmp</value>
|
||
|
|
</property></pre></tt>
|
||
|
|
|
||
|
|
When <tt>conf.get("tempdir")</tt> is called, then <tt>${<i>basedir</i>}</tt>
|
||
|
|
will be resolved to another property in this Configuration, while
|
||
|
|
<tt>${<i>user.name</i>}</tt> would then ordinarily be resolved to the value
|
||
|
|
of the System property with that name.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.conf.Configuration -->
|
||
|
|
<!-- start class org.apache.hadoop.conf.Configuration.IntegerRanges -->
|
||
|
|
<class name="Configuration.IntegerRanges" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="Configuration.IntegerRanges"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Configuration.IntegerRanges" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="isIncluded" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="value" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Is the given value in the set of ranges
|
||
|
|
@param value the value to check
|
||
|
|
@return is the value in the ranges?]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A class that represents a set of positive integer ranges. It parses
|
||
|
|
strings of the form: "2-3,5,7-" where ranges are separated by comma and
|
||
|
|
the lower/upper bounds are separated by dash. Either the lower or upper
|
||
|
|
bound may be omitted meaning all values up to or over. So the string
|
||
|
|
above means 2, 3, 5, and 7, 8, 9, ...]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.conf.Configuration.IntegerRanges -->
|
||
|
|
<!-- start class org.apache.hadoop.conf.Configured -->
|
||
|
|
<class name="Configured" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.conf.Configurable"/>
|
||
|
|
<constructor name="Configured"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a Configured.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Configured" type="org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a Configured.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="setConf"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
</method>
|
||
|
|
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Base class for things that may be configured with a {@link Configuration}.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.conf.Configured -->
|
||
|
|
<!-- start class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
|
||
|
|
<class name="ConfServlet.BadFormatException" extends="java.lang.Exception"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="ConfServlet.BadFormatException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.conf.ConfServlet.BadFormatException -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Configuration of system parameters.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.fs">
|
||
|
|
<!-- start class org.apache.hadoop.fs.AbstractFileSystem -->
|
||
|
|
<class name="AbstractFileSystem" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="AbstractFileSystem" type="java.net.URI, java.lang.String, boolean, int"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="URISyntaxException" type="java.net.URISyntaxException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor to be called by subclasses.
|
||
|
|
|
||
|
|
@param uri for this file system.
|
||
|
|
@param supportedScheme the scheme supported by the implementor
|
||
|
|
@param authorityNeeded if true then theURI must have authority, if false
|
||
|
|
then the URI must have null authority.
|
||
|
|
|
||
|
|
@throws URISyntaxException <code>uri</code> has syntax error]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getStatistics" return="org.apache.hadoop.fs.FileSystem.Statistics"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="scheme" type="java.lang.String"/>
|
||
|
|
<param name="cls" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the statistics for a particular file system.
|
||
|
|
@param cls the class to lookup
|
||
|
|
@return a statistics object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="clearStatistics"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="printStatistics"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="checkScheme"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="uri" type="java.net.URI"/>
|
||
|
|
<param name="supportedScheme" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<method name="getUriDefaultPort" return="int"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The default port of this file system.
|
||
|
|
|
||
|
|
@return default port of this file system's Uri scheme
|
||
|
|
A uri with a port of -1 => default port;]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getUri" return="java.net.URI"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a URI whose scheme and authority identify this FileSystem.
|
||
|
|
|
||
|
|
@return the uri of this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="checkPath"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="path" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check that a Path belongs to this FileSystem.
|
||
|
|
|
||
|
|
If the path is fully qualified URI, then its scheme and authority
|
||
|
|
matches that of this file system. Otherwise the path must be
|
||
|
|
slash-relative name.
|
||
|
|
|
||
|
|
@throws InvalidPathException if the path is invalid]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getUriPath" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="p" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the path-part of a pathname. Checks that URI matches this file system
|
||
|
|
and that the path-part is a valid name.
|
||
|
|
|
||
|
|
@param p path
|
||
|
|
|
||
|
|
@return path-part of the Path p]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getInitialWorkingDirectory" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Some file systems like LocalFileSystem have an initial workingDir
|
||
|
|
that is used as the starting workingDir. For other file systems
|
||
|
|
like HDFS there is no built in notion of an initial workingDir.
|
||
|
|
|
||
|
|
@return the initial workingDir if the file system has such a notion
|
||
|
|
otherwise return a null.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getHomeDirectory" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the current user's home directory in this file system.
|
||
|
|
The default implementation returns "/user/$USER/".
|
||
|
|
|
||
|
|
@return current user's home directory.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getServerDefaults" return="org.apache.hadoop.fs.FsServerDefaults"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return a set of server default configuration values.
|
||
|
|
|
||
|
|
@return server default configuration values
|
||
|
|
|
||
|
|
@throws IOException an I/O error occurred]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="createFlag" type="java.util.EnumSet"/>
|
||
|
|
<param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#create(Path, EnumSet, Options.CreateOpts...)} except
|
||
|
|
that the Path f must be fully qualified and the permission is absolute
|
||
|
|
(i.e. umask has been applied).]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInternal" return="org.apache.hadoop.fs.FSDataOutputStream"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="flag" type="java.util.EnumSet"/>
|
||
|
|
<param name="absolutePermission" type="org.apache.hadoop.fs.permission.FsPermission"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<param name="replication" type="short"/>
|
||
|
|
<param name="blockSize" type="long"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<param name="bytesPerChecksum" type="int"/>
|
||
|
|
<param name="createParent" type="boolean"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link #create(Path, EnumSet, Options.CreateOpts...)} except that the opts
|
||
|
|
have been declared explicitly.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="mkdir"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
|
||
|
|
<param name="createParent" type="boolean"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#mkdir(Path, FsPermission, boolean)} except that the Path
|
||
|
|
f must be fully qualified and the permission is absolute (i.e.
|
||
|
|
umask has been applied).]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="delete" return="boolean"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="recursive" type="boolean"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#delete(Path, boolean)} except that Path f must be for
|
||
|
|
this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#open(Path)} except that Path f must be for this
|
||
|
|
file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#open(Path, int)} except that Path f must be for this
|
||
|
|
file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setReplication" return="boolean"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="replication" type="short"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#setReplication(Path, short)} except that Path f must be
|
||
|
|
for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="rename"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="options" type="org.apache.hadoop.fs.Options.Rename[]"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
|
||
|
|
f must be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="renameInternal"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
|
||
|
|
f must be for this file system and NO OVERWRITE is performed.
|
||
|
|
|
||
|
|
File systems that do not have a built in overwrite need implement only this
|
||
|
|
method and can take advantage of the default impl of the other
|
||
|
|
{@link #renameInternal(Path, Path, boolean)}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="renameInternal"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="overwrite" type="boolean"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#rename(Path, Path, Options.Rename...)} except that Path
|
||
|
|
f must be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="supportsSymlinks" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if the file system supports symlinks, false otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createSymlink"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="target" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="link" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="createParent" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#createSymlink(Path, Path, boolean)};]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLinkTarget" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getLinkTarget(Path)};]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setPermission"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#setPermission(Path, FsPermission)} except that Path f
|
||
|
|
must be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setOwner"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="username" type="java.lang.String"/>
|
||
|
|
<param name="groupname" type="java.lang.String"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#setOwner(Path, String, String)} except that Path f must
|
||
|
|
be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTimes"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="mtime" type="long"/>
|
||
|
|
<param name="atime" type="long"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#setTimes(Path, long, long)} except that Path f must be
|
||
|
|
for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileChecksum" return="org.apache.hadoop.fs.FileChecksum"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFileChecksum(Path)} except that Path f must be for
|
||
|
|
this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileStatus" return="org.apache.hadoop.fs.FileStatus"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFileStatus(Path)}
|
||
|
|
except that an UnresolvedLinkException may be thrown if a symlink is
|
||
|
|
encountered in the path.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileLinkStatus" return="org.apache.hadoop.fs.FileStatus"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFileLinkStatus(Path)}
|
||
|
|
except that an UnresolvedLinkException may be thrown if a symlink is
|
||
|
|
encountered in the path leading up to the final path component.
|
||
|
|
If the file system does not support symlinks then the behavior is
|
||
|
|
equivalent to {@link AbstractFileSystem#getFileStatus(Path)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileBlockLocations" return="org.apache.hadoop.fs.BlockLocation[]"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="start" type="long"/>
|
||
|
|
<param name="len" type="long"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFileBlockLocations(Path, long, long)} except that
|
||
|
|
Path f must be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFsStatus(Path)} except that Path f must be for this
|
||
|
|
file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFsStatus" return="org.apache.hadoop.fs.FsStatus"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#getFsStatus(Path)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="listStatusIterator" return="java.util.Iterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#listStatus(Path)} except that Path f must be for this
|
||
|
|
file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="UnresolvedLinkException" type="org.apache.hadoop.fs.UnresolvedLinkException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext.Util#listStatus(Path)} except that Path f must be
|
||
|
|
for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setVerifyChecksum"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="verifyChecksum" type="boolean"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The specification of this method matches that of
|
||
|
|
{@link FileContext#setVerifyChecksum(boolean, Path)} except that Path f
|
||
|
|
must be for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="statistics" type="org.apache.hadoop.fs.FileSystem.Statistics"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The statistics for this file system.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class provides an interface for implementors of a Hadoop file system
|
||
|
|
(analogous to the VFS of Unix). Applications do not access this class;
|
||
|
|
instead they access files across all file systems using {@link FileContext}.
|
||
|
|
|
||
|
|
Pathnames passed to AbstractFileSystem can be fully qualified URI that
|
||
|
|
matches the "this" file system (ie same scheme and authority)
|
||
|
|
or a Slash-relative name that is assumed to be relative
|
||
|
|
to the root of the "this" file system .]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.AbstractFileSystem -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.AvroFSInput -->
|
||
|
|
<class name="AvroFSInput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<implements name="org.apache.avro.file.SeekableInput"/>
|
||
|
|
<constructor name="AvroFSInput" type="org.apache.hadoop.fs.FSDataInputStream, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct given an {@link FSDataInputStream} and its length.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="AvroFSInput" type="org.apache.hadoop.fs.FileContext, org.apache.hadoop.fs.Path"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct given a {@link FileContext} and a {@link Path}.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="length" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="read" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="byte[]"/>
|
||
|
|
<param name="off" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="seek"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="p" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="tell" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="close"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adapts an {@link FSDataInputStream} to Avro's SeekableInput interface.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.AvroFSInput -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.BlockLocation -->
|
||
|
|
<class name="BlockLocation" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="BlockLocation"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default Constructor]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], long, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor with host, name, offset and length]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BlockLocation" type="java.lang.String[], java.lang.String[], java.lang.String[], long, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor with host, name, network topology, offset and length]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getHosts" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the list of hosts (hostname) hosting this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getNames" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the list of names (hostname:port) hosting this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTopologyPaths" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the list of network topology paths for each of the hosts.
|
||
|
|
The last component of the path is the host.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getOffset" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the start offset of file associated with this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLength" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the length of the block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setOffset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="offset" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the start offset of file associated with this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setLength"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="length" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the length of block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setHosts"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="hosts" type="java.lang.String[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the hosts hosting this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setNames"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="names" type="java.lang.String[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the names (host:port) hosting this block]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTopologyPaths"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="topologyPaths" type="java.lang.String[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the network topology paths of the hosts]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="write"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Implement write of Writable]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readFields"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.DataInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Implement readFields of Writable]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.BlockLocation -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.ChecksumException -->
|
||
|
|
<class name="ChecksumException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="ChecksumException" type="java.lang.String, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getPos" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Thrown for checksum errors.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.ChecksumException -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.ChecksumFileSystem -->
|
||
|
|
<class name="ChecksumFileSystem" extends="org.apache.hadoop.fs.FilterFileSystem"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="ChecksumFileSystem" type="org.apache.hadoop.fs.FileSystem"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getApproxChkSumLength" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="size" type="long"/>
|
||
|
|
</method>
|
||
|
|
<method name="setConf"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
</method>
|
||
|
|
<method name="setVerifyChecksum"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="verifyChecksum" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set whether to verify checksum.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getRawFileSystem" return="org.apache.hadoop.fs.FileSystem"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[get the raw file system]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getChecksumFile" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="file" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the name of the checksum file associated with a file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isChecksumFile" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="file" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return true iff file is a checksum file name.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getChecksumFileLength" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="file" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="fileSize" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the length of the checksum file given the size of the
|
||
|
|
actual file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getBytesPerSum" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the bytes Per Checksum]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="open" return="org.apache.hadoop.fs.FSDataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Opens an FSDataInputStream at the indicated Path.
|
||
|
|
@param f the file name to open
|
||
|
|
@param bufferSize the size of the buffer to be used.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append" return="org.apache.hadoop.fs.FSDataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getChecksumLength" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="size" type="long"/>
|
||
|
|
<param name="bytesPerSum" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Calculated the length of the checksum file in bytes.
|
||
|
|
@param size the length of the data file in bytes
|
||
|
|
@param bytesPerSum the number of bytes in a checksum block
|
||
|
|
@return the number of bytes in the checksum file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="permission" type="org.apache.hadoop.fs.permission.FsPermission"/>
|
||
|
|
<param name="overwrite" type="boolean"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<param name="replication" type="short"/>
|
||
|
|
<param name="blockSize" type="long"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setReplication" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="replication" type="short"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set replication for an existing file.
|
||
|
|
Implement the abstract <tt>setReplication</tt> of <tt>FileSystem</tt>
|
||
|
|
@param src file name
|
||
|
|
@param replication new replication
|
||
|
|
@throws IOException
|
||
|
|
@return true if successful;
|
||
|
|
false if file does not exist or is a directory]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="rename" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Rename files/dirs]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="delete" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="recursive" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Implement the delete(Path, boolean) in checksum
|
||
|
|
file system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[List the statuses of the files/directories in the given path if the path is
|
||
|
|
a directory.
|
||
|
|
|
||
|
|
@param f
|
||
|
|
given path
|
||
|
|
@return the statuses of the files/directories in the given patch
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="mkdirs" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="copyFromLocalFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="delSrc" type="boolean"/>
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="copyToLocalFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="delSrc" type="boolean"/>
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The src file is under FS, and the dst is on the local disk.
|
||
|
|
Copy it from FS control to the local dst name.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="copyToLocalFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="src" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="dst" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="copyCrc" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The src file is under FS, and the dst is on the local disk.
|
||
|
|
Copy it from FS control to the local dst name.
|
||
|
|
If src and dst are directories, the copyCrc parameter
|
||
|
|
determines whether to copy CRC files.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startLocalOutput" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="completeLocalOutput"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fsOutputFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="tmpLocalFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="reportChecksumFailure" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="in" type="org.apache.hadoop.fs.FSDataInputStream"/>
|
||
|
|
<param name="inPos" type="long"/>
|
||
|
|
<param name="sums" type="org.apache.hadoop.fs.FSDataInputStream"/>
|
||
|
|
<param name="sumsPos" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Report a checksum error to the file system.
|
||
|
|
@param f the file name containing the error
|
||
|
|
@param in the stream open on the file
|
||
|
|
@param inPos the position of the beginning of the bad data in the file
|
||
|
|
@param sums the stream open on the checksum file
|
||
|
|
@param sumsPos the position of the beginning of the bad data in the checksum file
|
||
|
|
@return if retry is neccessary]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Abstract Checksumed FileSystem.
|
||
|
|
It provide a basice implementation of a Checksumed FileSystem,
|
||
|
|
which creates a checksum file for each raw file.
|
||
|
|
It generates & verifies checksums at the client side.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.ChecksumFileSystem -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.ContentSummary -->
|
||
|
|
<class name="ContentSummary" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="ContentSummary"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="ContentSummary" type="long, long, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="ContentSummary" type="long, long, long, long, long, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getLength" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return the length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDirectoryCount" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return the directory count]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileCount" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return the file count]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getQuota" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the directory quota]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getSpaceConsumed" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Retuns (disk) space consumed]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getSpaceQuota" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns (disk) space quota]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="write"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readFields"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.DataInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getHeader" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="qOption" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the header of the output.
|
||
|
|
if qOption is false, output directory count, file count, and content size;
|
||
|
|
if qOption is true, output quota and remaining quota as well.
|
||
|
|
|
||
|
|
@param qOption a flag indicating if quota needs to be printed or not
|
||
|
|
@return the header of the output]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="qOption" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the string representation of the object in the output format.
|
||
|
|
if qOption is false, output directory count, file count, and content size;
|
||
|
|
if qOption is true, output quota and remaining quota as well.
|
||
|
|
|
||
|
|
@param qOption a flag indicating if quota needs to be printed or not
|
||
|
|
@return the string representation of the object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Store the summary of a content (a directory or a file).]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.ContentSummary -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.CreateFlag -->
|
||
|
|
<class name="CreateFlag" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.fs.CreateFlag[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.fs.CreateFlag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[CreateFlag specifies the file create semantic. Users can combine flags like:<br>
|
||
|
|
<code>
|
||
|
|
EnumSet.of(CreateFlag.CREATE, CreateFlag.APPEND)
|
||
|
|
<code>
|
||
|
|
and pass it to {@link org.apache.hadoop.fs.FileSystem #create(Path f, FsPermission permission,
|
||
|
|
EnumSet<CreateFlag> flag, int bufferSize, short replication, long blockSize,
|
||
|
|
Progressable progress)}.
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Combine {@link #OVERWRITE} with either {@link #CREATE}
|
||
|
|
or {@link #APPEND} does the same as only use
|
||
|
|
{@link #OVERWRITE}. <br>
|
||
|
|
Combine {@link #CREATE} with {@link #APPEND} has the semantic:
|
||
|
|
<ol>
|
||
|
|
<li> create the file if it does not exist;
|
||
|
|
<li> append the file if it already exists.
|
||
|
|
</ol>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.CreateFlag -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.FileAlreadyExistsException -->
|
||
|
|
<class name="FileAlreadyExistsException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="FileAlreadyExistsException"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="FileAlreadyExistsException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Used when target file already exists for any operation and
|
||
|
|
is not configured to be overwritten.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.FileAlreadyExistsException -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.FileChecksum -->
|
||
|
|
<class name="FileChecksum" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="FileChecksum"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getAlgorithmName" return="java.lang.String"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The checksum algorithm name]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLength" return="int"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The length of the checksum in bytes]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getBytes" return="byte[]"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The value of the checksum in bytes]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="equals" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="other" type="java.lang.Object"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return true if both the algorithms and the values are the same.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An abstract class representing file checksums for files.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.fs.FileChecksum -->
|
||
|
|
<!-- start class org.apache.hadoop.fs.FileContext -->
|
||
|
|
<class name="FileContext" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="defFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
|
||
|
|
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext with specified FS as default using the specified
|
||
|
|
config.
|
||
|
|
|
||
|
|
@param defFS
|
||
|
|
@param aConf
|
||
|
|
@return new FileContext with specifed FS as default.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="defaultFS" type="org.apache.hadoop.fs.AbstractFileSystem"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext for specified file system using the default config.
|
||
|
|
|
||
|
|
@param defaultFS
|
||
|
|
@return a FileContext with the specified AbstractFileSystem
|
||
|
|
as the default FS.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext using the default config read from the
|
||
|
|
$HADOOP_CONFIG/core.xml, Unspecified key-values for config are defaulted
|
||
|
|
from core-defaults.xml in the release jar.
|
||
|
|
|
||
|
|
@throws UnsupportedFileSystemException If the file system from the default
|
||
|
|
configuration is not supported]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return a FileContext for the local file system using the default config.
|
||
|
|
@throws UnsupportedFileSystemException If the file system for
|
||
|
|
{@link FsConstants#LOCAL_FS_URI} is not supported.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="defaultFsUri" type="java.net.URI"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext for specified URI using the default config.
|
||
|
|
|
||
|
|
@param defaultFsUri
|
||
|
|
@return a FileContext with the specified URI as the default FS.
|
||
|
|
|
||
|
|
@throws UnsupportedFileSystemException If the file system for
|
||
|
|
<code>defaultFsUri</code> is not supported]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="defaultFsUri" type="java.net.URI"/>
|
||
|
|
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext for specified default URI using the specified config.
|
||
|
|
|
||
|
|
@param defaultFsUri
|
||
|
|
@param aConf
|
||
|
|
@return new FileContext for specified uri
|
||
|
|
@throws UnsupportedFileSystemException If the file system with specified is
|
||
|
|
not supported]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a FileContext using the passed config. Generally it is better to use
|
||
|
|
{@link #getFileContext(URI, Configuration)} instead of this one.
|
||
|
|
|
||
|
|
|
||
|
|
@param aConf
|
||
|
|
@return new FileContext
|
||
|
|
@throws UnsupportedFileSystemException If file system in the config
|
||
|
|
is not supported]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLocalFSFileContext" return="org.apache.hadoop.fs.FileContext"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="aConf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@param aConf - from which the FileContext is configured
|
||
|
|
@return a FileContext for the local file system using the specified config.
|
||
|
|
|
||
|
|
@throws UnsupportedFileSystemException If default file system in the config
|
||
|
|
is not supported]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDefaultFileSystem" return="org.apache.hadoop.fs.AbstractFileSystem"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="setWorkingDirectory"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="newWDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the working directory for wd-relative names (such a "foo/bar").
|
||
|
|
@param newWDir
|
||
|
|
@throws IOException
|
||
|
|
|
||
|
|
newWdir can be one of
|
||
|
|
- relative path: "foo/bar";
|
||
|
|
- absolute without scheme: "/foo/bar"
|
||
|
|
- fully qualified with scheme: "xx://auth/foo/bar"
|
||
|
|
Illegal WDs:
|
||
|
|
- relative with scheme: "xx:foo/bar"]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Gets the working directory for wd-relative names (such a "foo/bar").]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getUMask" return="org.apache.hadoop.fs.permission.FsPermission"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return the umask of this FileContext]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setUMask"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="newUmask" type="org.apache.hadoop.fs.permission.FsPermission"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set umask to the supplied parameter.
|
||
|
|
@param newUmask the new umask]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="makeQualified" return="org.apache.hadoop.fs.Path"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="path" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Make the path fully qualified if it is isn't.
|
||
|
|
A Fully-qualified path has scheme and authority specified and an absolute
|
||
|
|
path.
|
||
|
|
Use the default file system and working dir in this FileContext to qualify.
|
||
|
|
@param path
|
||
|
|
@return qualified path]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="create" return="org.apache.hadoop.fs.FSDataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="createFlag" type="java.util.EnumSet"/>
|
||
|
|
<param name="opts" type="org.apache.hadoop.fs.Options.CreateOpts[]"/>
|
||
|
|
<exception name="AccessControlException" type="org.apache.hadoop.security.AccessControlException"/>
|
||
|
|
<exception name="FileAlreadyExistsException" type="org.apache.hadoop.fs.FileAlreadyExistsException"/>
|
||
|
|
<exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
|
||
|
|
<exception name="ParentNotDirectoryException" type="org.apache.hadoop.fs.ParentNotDirectoryException"/>
|
||
|
|
<exception name="UnsupportedFileSystemException" type="org.apache.hadoop.fs.UnsupportedFileSystemException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![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 un-interpreted target of the given symbolic link.
|
||
|
|
Transparently resolves all links up to the final path component.
|
||
|
|
@param f
|
||
|
|
@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 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 storign 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="java.util.Iterator"
|
||
|
|
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="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="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="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 syste
|
||
|
|
@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="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="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="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="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="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.]]>
|
||
|
|
</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.]]>
|
||
|
|
</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="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>
|
||
|
|
<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"/>
|
||
|
|
<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.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="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.]]>
|
||
|
|
</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.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">
|
||
|
|
<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.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.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>
|
||
|
|
<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="getBytes" return="byte[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the data from the BytesWritable.
|
||
|
|
@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.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 a map reader for the named map.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a map reader for the named map using the named comparator.]]>
|
||
|
|
</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, boolean"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Hook to allow subclasses to defer opening streams until further
|
||
|
|
initialization is complete.
|
||
|
|
@see #createDataFileReader(FileSystem, Path, Configuration)]]>
|
||
|
|
</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="open"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
|
||
|
|
<param name="dirName" type="java.lang.String"/>
|
||
|
|
<param name="comparator" type="org.apache.hadoop.io.WritableComparator"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<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="fs" type="org.apache.hadoop.fs.FileSystem"/>
|
||
|
|
<param name="dataFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<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 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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map for keys of the named class.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map for keys of the named class.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map for keys of the named class.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map for keys of the named class.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map using the named key comparator.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map using the named key comparator.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map using the named key comparator.]]>
|
||
|
|
</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="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named map using the named key comparator.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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 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="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="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.SequenceFile -->
|
||
|
|
<class name="SequenceFile" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="getCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="job" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the compression type for the reduce outputs
|
||
|
|
@param job the job config to look in
|
||
|
|
@return the kind of compression to use]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setCompressionType"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="job" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="val" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the compression type for sequence files.
|
||
|
|
@param job the configuration to modify
|
||
|
|
@param val the new compression type (none, block, record)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param progress The Progressable object to track progress.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@param progress The Progressable object to track progress.
|
||
|
|
@param metadata The metadata of the file.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<param name="replication" type="short"/>
|
||
|
|
<param name="blockSize" type="long"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param bufferSize buffer size for the underlaying outputstream.
|
||
|
|
@param replication replication factor for the file.
|
||
|
|
@param blockSize block size for the file.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@param progress The Progressable object to track progress.
|
||
|
|
@param metadata The metadata of the file.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<param name="name" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<param name="progress" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of SequenceFile Writer.
|
||
|
|
@param fs The configured filesystem.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param name The name of the file.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@param progress The Progressable object to track progress.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<param name="metadata" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param out The stream on top which the writer is to be constructed.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@param metadata The metadata of the file.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createWriter" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
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="out" type="org.apache.hadoop.fs.FSDataOutputStream"/>
|
||
|
|
<param name="keyClass" type="java.lang.Class"/>
|
||
|
|
<param name="valClass" type="java.lang.Class"/>
|
||
|
|
<param name="compressionType" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the preferred type of 'raw' SequenceFile Writer.
|
||
|
|
@param conf The configuration.
|
||
|
|
@param out The stream on top which the writer is to be constructed.
|
||
|
|
@param keyClass The 'key' type.
|
||
|
|
@param valClass The 'value' type.
|
||
|
|
@param compressionType The compression type.
|
||
|
|
@param codec The compression codec.
|
||
|
|
@return Returns the handle to the constructed SequenceFile Writer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="SYNC_INTERVAL" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The number of bytes between sync points.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<code>SequenceFile</code>s are flat files consisting of binary key/value
|
||
|
|
pairs.
|
||
|
|
|
||
|
|
<p><code>SequenceFile</code> provides {@link Writer}, {@link Reader} and
|
||
|
|
{@link Sorter} classes for writing, reading and sorting respectively.</p>
|
||
|
|
|
||
|
|
There are three <code>SequenceFile</code> <code>Writer</code>s based on the
|
||
|
|
{@link CompressionType} used to compress key/value pairs:
|
||
|
|
<ol>
|
||
|
|
<li>
|
||
|
|
<code>Writer</code> : Uncompressed records.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<code>RecordCompressWriter</code> : Record-compressed files, only compress
|
||
|
|
values.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<code>BlockCompressWriter</code> : Block-compressed files, both keys &
|
||
|
|
values are collected in 'blocks'
|
||
|
|
separately and compressed. The size of
|
||
|
|
the 'block' is configurable.
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<p>The actual compression algorithm used to compress key and/or values can be
|
||
|
|
specified by using the appropriate {@link CompressionCodec}.</p>
|
||
|
|
|
||
|
|
<p>The recommended way is to use the static <tt>createWriter</tt> methods
|
||
|
|
provided by the <code>SequenceFile</code> to chose the preferred format.</p>
|
||
|
|
|
||
|
|
<p>The {@link Reader} acts as the bridge and can read any of the above
|
||
|
|
<code>SequenceFile</code> formats.</p>
|
||
|
|
|
||
|
|
<h4 id="Formats">SequenceFile Formats</h4>
|
||
|
|
|
||
|
|
<p>Essentially there are 3 different formats for <code>SequenceFile</code>s
|
||
|
|
depending on the <code>CompressionType</code> specified. All of them share a
|
||
|
|
<a href="#Header">common header</a> described below.
|
||
|
|
|
||
|
|
<h5 id="Header">SequenceFile Header</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
version - 3 bytes of magic header <b>SEQ</b>, followed by 1 byte of actual
|
||
|
|
version number (e.g. SEQ4 or SEQ6)
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
keyClassName -key class
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
valueClassName - value class
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
compression - A boolean which specifies if compression is turned on for
|
||
|
|
keys/values in this file.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
blockCompression - A boolean which specifies if block-compression is
|
||
|
|
turned on for keys/values in this file.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
compression codec - <code>CompressionCodec</code> class which is used for
|
||
|
|
compression of keys and/or values (if compression is
|
||
|
|
enabled).
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
metadata - {@link Metadata} for this file.
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
sync - A sync marker to denote end of the header.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h5 id="#UncompressedFormat">Uncompressed SequenceFile Format</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="#Header">Header</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
Record
|
||
|
|
<ul>
|
||
|
|
<li>Record length</li>
|
||
|
|
<li>Key length</li>
|
||
|
|
<li>Key</li>
|
||
|
|
<li>Value</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
A sync-marker every few <code>100</code> bytes or so.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h5 id="#RecordCompressedFormat">Record-Compressed SequenceFile Format</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="#Header">Header</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
Record
|
||
|
|
<ul>
|
||
|
|
<li>Record length</li>
|
||
|
|
<li>Key length</li>
|
||
|
|
<li>Key</li>
|
||
|
|
<li><i>Compressed</i> Value</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
A sync-marker every few <code>100</code> bytes or so.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h5 id="#BlockCompressedFormat">Block-Compressed SequenceFile Format</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="#Header">Header</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
Record <i>Block</i>
|
||
|
|
<ul>
|
||
|
|
<li>Compressed key-lengths block-size</li>
|
||
|
|
<li>Compressed key-lengths block</li>
|
||
|
|
<li>Compressed keys block-size</li>
|
||
|
|
<li>Compressed keys block</li>
|
||
|
|
<li>Compressed value-lengths block-size</li>
|
||
|
|
<li>Compressed value-lengths block</li>
|
||
|
|
<li>Compressed values block-size</li>
|
||
|
|
<li>Compressed values block</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
A sync-marker every few <code>100</code> bytes or so.
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>The compressed blocks of key lengths and value lengths consist of the
|
||
|
|
actual lengths of individual keys/values encoded in ZeroCompressedInteger
|
||
|
|
format.</p>
|
||
|
|
|
||
|
|
@see CompressionCodec]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.CompressionType -->
|
||
|
|
<class name="SequenceFile.CompressionType" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.io.SequenceFile.CompressionType[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.io.SequenceFile.CompressionType"
|
||
|
|
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[The compression type used to compress key/value pairs in the
|
||
|
|
{@link SequenceFile}.
|
||
|
|
|
||
|
|
@see SequenceFile.Writer]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.CompressionType -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.Metadata -->
|
||
|
|
<class name="SequenceFile.Metadata" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="SequenceFile.Metadata"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Metadata" type="java.util.TreeMap"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="get" return="org.apache.hadoop.io.Text"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="org.apache.hadoop.io.Text"/>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="org.apache.hadoop.io.Text"/>
|
||
|
|
<param name="value" type="org.apache.hadoop.io.Text"/>
|
||
|
|
</method>
|
||
|
|
<method name="getMetadata" return="java.util.TreeMap"
|
||
|
|
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>
|
||
|
|
<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="equals" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="other" type="org.apache.hadoop.io.SequenceFile.Metadata"/>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</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[The class encapsulating with the metadata of a file.
|
||
|
|
The metadata of a file is a list of attribute name/value
|
||
|
|
pairs of Text type.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.Metadata -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.Reader -->
|
||
|
|
<class name="SequenceFile.Reader" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<constructor name="SequenceFile.Reader" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.Path, 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 reader by opening a file from the given file system.
|
||
|
|
@param fs The file system used to open the file.
|
||
|
|
@param file The file being read.
|
||
|
|
@param conf Configuration
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Reader" type="org.apache.hadoop.fs.FSDataInputStream, int, long, long, 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 reader by the given input stream.
|
||
|
|
@param in An input stream.
|
||
|
|
@param buffersize The buffer size used to read the file.
|
||
|
|
@param start The starting position.
|
||
|
|
@param length The length being read.
|
||
|
|
@param conf Configuration
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="openFile" return="org.apache.hadoop.fs.FSDataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
|
||
|
|
<param name="file" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="bufferSize" type="int"/>
|
||
|
|
<param name="length" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Override this method to specialize the type of
|
||
|
|
{@link FSDataInputStream} returned.
|
||
|
|
@param fs The file system used to open the file.
|
||
|
|
@param file The file being read.
|
||
|
|
@param bufferSize The buffer size used to read the file.
|
||
|
|
@param length The length being read if it is >= 0. Otherwise,
|
||
|
|
the length is not available.
|
||
|
|
@return The opened stream.
|
||
|
|
@throws IOException]]>
|
||
|
|
</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 file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKeyClassName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the name of the key class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKeyClass" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the class of keys in this file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValueClassName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the name of the value class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValueClass" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the class of values in this file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isCompressed" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if values are compressed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isBlockCompressed" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if records are block-compressed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCompressionCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the compression codec of data in this file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMetadata" return="org.apache.hadoop.io.SequenceFile.Metadata"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the metadata object of the file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCurrentValue"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="val" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the 'value' corresponding to the last read 'key'.
|
||
|
|
@param val : The 'value' to be read.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCurrentValue" return="java.lang.Object"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="val" type="java.lang.Object"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the 'value' corresponding to the last read 'key'.
|
||
|
|
@param val : The 'value' to be read.
|
||
|
|
@throws IOException]]>
|
||
|
|
</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.Writable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read the next key in the file into <code>key</code>, skipping its
|
||
|
|
value. True if another entry exists, and false at end of file.]]>
|
||
|
|
</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.Writable"/>
|
||
|
|
<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 file into <code>key</code> and
|
||
|
|
<code>val</code>. Returns true if such a pair exists and false when at
|
||
|
|
end of file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="next" return="int"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Call {@link #nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)}.">
|
||
|
|
<param name="buffer" type="org.apache.hadoop.io.DataOutputBuffer"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Call {@link #nextRaw(DataOutputBuffer,SequenceFile.ValueBytes)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createValueBytes" return="org.apache.hadoop.io.SequenceFile.ValueBytes"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="nextRaw" return="int"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.io.DataOutputBuffer"/>
|
||
|
|
<param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read 'raw' records.
|
||
|
|
@param key - The buffer into which the key is read
|
||
|
|
@param val - The 'raw' value
|
||
|
|
@return Returns the total record length or -1 for end of file
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="nextRawKey" return="int"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.io.DataOutputBuffer"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read 'raw' keys.
|
||
|
|
@param key - The buffer into which the key is read
|
||
|
|
@return Returns the key length or -1 for end of file
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="next" return="java.lang.Object"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="java.lang.Object"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read the next key in the file, skipping its
|
||
|
|
value. Return null at end of file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="nextRawValue" return="int"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read 'raw' values.
|
||
|
|
@param val - The 'raw' value
|
||
|
|
@return Returns the value length
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="seek"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="position" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the current byte position in the input file.
|
||
|
|
|
||
|
|
<p>The position passed must be a position returned by {@link
|
||
|
|
SequenceFile.Writer#getLength()} when writing this file. To seek to an arbitrary
|
||
|
|
position, use {@link SequenceFile.Reader#sync(long)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="sync"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="position" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Seek to the next sync mark past a given position.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="syncSeen" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true iff the previous call to next passed a sync mark.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getPosition" 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[Return the current byte position in the input file.]]>
|
||
|
|
</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 the name of the file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads key/value pairs from a sequence-format file.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.Reader -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.Sorter -->
|
||
|
|
<class name="SequenceFile.Sorter" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SequenceFile.Sorter" type="org.apache.hadoop.fs.FileSystem, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sort and merge files containing the named classes.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Sorter" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sort and merge using an arbitrary {@link RawComparator}.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Sorter" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class, org.apache.hadoop.conf.Configuration, org.apache.hadoop.io.SequenceFile.Metadata"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sort and merge using an arbitrary {@link RawComparator}.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="setFactor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="factor" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the number of streams to merge at once.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFactor" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the number of streams to merge at once.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMemory"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="memory" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the total amount of buffer memory, in bytes.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMemory" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the total amount of buffer memory, in bytes.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setProgressable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="progressable" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the progressable object in order to report progress.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="sort"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="outFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="deleteInput" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Perform a file sort from a set of input files into an output file.
|
||
|
|
@param inFiles the files to be sorted
|
||
|
|
@param outFile the sorted output file
|
||
|
|
@param deleteInput should the input files be deleted as they are read?]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="sortAndIterate" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="tempDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="deleteInput" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Perform a file sort from a set of input files and return an iterator.
|
||
|
|
@param inFiles the files to be sorted
|
||
|
|
@param tempDir the directory where temp files are created during sort
|
||
|
|
@param deleteInput should the input files be deleted as they are read?
|
||
|
|
@return iterator the RawKeyValueIterator]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="sort"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="outFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The backwards compatible interface to sort.
|
||
|
|
@param inFile the input file to sort
|
||
|
|
@param outFile the sorted output file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="segments" type="java.util.List"/>
|
||
|
|
<param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Merges the list of segments of type <code>SegmentDescriptor</code>
|
||
|
|
@param segments the list of SegmentDescriptors
|
||
|
|
@param tmpDir the directory to write temporary files into
|
||
|
|
@return RawKeyValueIterator
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="deleteInputs" type="boolean"/>
|
||
|
|
<param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Merges the contents of files passed in Path[] using a max factor value
|
||
|
|
that is already set
|
||
|
|
@param inNames the array of path names
|
||
|
|
@param deleteInputs true if the input files should be deleted when
|
||
|
|
unnecessary
|
||
|
|
@param tmpDir the directory to write temporary files into
|
||
|
|
@return RawKeyValueIteratorMergeQueue
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="deleteInputs" type="boolean"/>
|
||
|
|
<param name="factor" type="int"/>
|
||
|
|
<param name="tmpDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Merges the contents of files passed in Path[]
|
||
|
|
@param inNames the array of path names
|
||
|
|
@param deleteInputs true if the input files should be deleted when
|
||
|
|
unnecessary
|
||
|
|
@param factor the factor that will be used as the maximum merge fan-in
|
||
|
|
@param tmpDir the directory to write temporary files into
|
||
|
|
@return RawKeyValueIteratorMergeQueue
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="merge" return="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inNames" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="tempDir" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="deleteInputs" type="boolean"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Merges the contents of files passed in Path[]
|
||
|
|
@param inNames the array of path names
|
||
|
|
@param tempDir the directory for creating temp files during merge
|
||
|
|
@param deleteInputs true if the input files should be deleted when
|
||
|
|
unnecessary
|
||
|
|
@return RawKeyValueIteratorMergeQueue
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="cloneFileAttributes" return="org.apache.hadoop.io.SequenceFile.Writer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inputFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="outputFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<param name="prog" type="org.apache.hadoop.util.Progressable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Clones the attributes (like compression of the input file and creates a
|
||
|
|
corresponding Writer
|
||
|
|
@param inputFile the path of the input file whose attributes should be
|
||
|
|
cloned
|
||
|
|
@param outputFile the path of the output file
|
||
|
|
@param prog the Progressable to report status during the file write
|
||
|
|
@return Writer
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="records" type="org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator"/>
|
||
|
|
<param name="writer" type="org.apache.hadoop.io.SequenceFile.Writer"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Writes records from RawKeyValueIterator into a file represented by the
|
||
|
|
passed writer
|
||
|
|
@param records the RawKeyValueIterator
|
||
|
|
@param writer the Writer created earlier
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="merge"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inFiles" type="org.apache.hadoop.fs.Path[]"/>
|
||
|
|
<param name="outFile" type="org.apache.hadoop.fs.Path"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Merge the provided files.
|
||
|
|
@param inFiles the array of input path names
|
||
|
|
@param outFile the final output file
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sorts key/value pairs in a sequence-format file.
|
||
|
|
|
||
|
|
<p>For best performance, applications should make sure that the {@link
|
||
|
|
Writable#readFields(DataInput)} implementation of their keys is
|
||
|
|
very efficient. In particular, it should avoid allocating memory.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.Sorter -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator -->
|
||
|
|
<interface name="SequenceFile.Sorter.RawKeyValueIterator" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="getKey" return="org.apache.hadoop.io.DataOutputBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Gets the current raw key
|
||
|
|
@return DataOutputBuffer
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValue" return="org.apache.hadoop.io.SequenceFile.ValueBytes"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Gets the current raw value
|
||
|
|
@return ValueBytes
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="next" 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[Sets up the current key and value (for getKey and getValue)
|
||
|
|
@return true if there exists a key/value, false otherwise
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="close"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[closes the iterator so that the underlying streams can be closed
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getProgress" return="org.apache.hadoop.util.Progress"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Gets the Progress object; this has a float (0.0 - 1.0)
|
||
|
|
indicating the bytes processed by the iterator so far]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The interface to iterate over raw keys/values of SequenceFiles.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.SequenceFile.Sorter.RawKeyValueIterator -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.Sorter.SegmentDescriptor -->
|
||
|
|
<class name="SequenceFile.Sorter.SegmentDescriptor" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.Comparable"/>
|
||
|
|
<constructor name="SequenceFile.Sorter.SegmentDescriptor" type="long, long, org.apache.hadoop.fs.Path"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructs a segment
|
||
|
|
@param segmentOffset the offset of the segment in the file
|
||
|
|
@param segmentLength the length of the segment
|
||
|
|
@param segmentPathName the path name of the file containing the segment]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="doSync"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do the sync checks]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="preserveInput"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="preserve" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Whether to delete the files when no longer needed]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="shouldPreserveInput" return="boolean"
|
||
|
|
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="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="nextRawKey" 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[Fills up the rawKey object with the key returned by the Reader
|
||
|
|
@return true if there is a key returned; false, otherwise
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="nextRawValue" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rawValue" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Fills up the passed rawValue with the value corresponding to the key
|
||
|
|
read earlier
|
||
|
|
@param rawValue
|
||
|
|
@return the length of the value
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKey" return="org.apache.hadoop.io.DataOutputBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the stored rawKey]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="cleanup"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The default cleanup. Subclasses can override this with a custom
|
||
|
|
cleanup]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class defines a merge segment. This class can be subclassed to
|
||
|
|
provide a customized cleanup method implementation. In this
|
||
|
|
implementation, cleanup closes the file handle and deletes the file]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.Sorter.SegmentDescriptor -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.SequenceFile.ValueBytes -->
|
||
|
|
<interface name="SequenceFile.ValueBytes" abstract="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="writeUncompressedBytes"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="outStream" type="java.io.DataOutputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Writes the uncompressed bytes to the outStream.
|
||
|
|
@param outStream : Stream to write uncompressed bytes into.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeCompressedBytes"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="outStream" type="java.io.DataOutputStream"/>
|
||
|
|
<exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write compressed bytes to outStream.
|
||
|
|
Note: that it will NOT compress the bytes if they are not compressed.
|
||
|
|
@param outStream : Stream to write compressed bytes into.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Size of stored data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The interface to 'raw' values of SequenceFiles.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.SequenceFile.ValueBytes -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SequenceFile.Writer -->
|
||
|
|
<class name="SequenceFile.Writer" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, 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.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, java.lang.Class, org.apache.hadoop.util.Progressable, org.apache.hadoop.io.SequenceFile.Metadata"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named file with write-progress reporter.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SequenceFile.Writer" type="org.apache.hadoop.fs.FileSystem, org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.Path, java.lang.Class, java.lang.Class, int, short, long, org.apache.hadoop.util.Progressable, org.apache.hadoop.io.SequenceFile.Metadata"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named file with write-progress reporter.]]>
|
||
|
|
</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="getCompressionCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the compression codec of data in this file.]]>
|
||
|
|
</doc>
|
||
|
|
</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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[create a sync point]]>
|
||
|
|
</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 file.]]>
|
||
|
|
</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.Writable"/>
|
||
|
|
<param name="val" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Append a key/value pair.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="java.lang.Object"/>
|
||
|
|
<param name="val" type="java.lang.Object"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Append a key/value pair.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="appendRaw"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="keyData" type="byte[]"/>
|
||
|
|
<param name="keyOffset" type="int"/>
|
||
|
|
<param name="keyLength" type="int"/>
|
||
|
|
<param name="val" type="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="getLength" 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 current length of the output file.
|
||
|
|
|
||
|
|
<p>This always returns a synchronized position. In other words,
|
||
|
|
immediately after calling {@link SequenceFile.Reader#seek(long)} with a position
|
||
|
|
returned by this method, {@link SequenceFile.Reader#next(Writable)} may be called. However
|
||
|
|
the key may be earlier in the file than key last written when this
|
||
|
|
method was called (e.g., with block-compression, it may be the first key
|
||
|
|
in the block that was being written when this method was called).]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="keySerializer" type="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="uncompressedValSerializer" type="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="compressedValSerializer" type="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write key/value pairs to a sequence-format file.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SequenceFile.Writer -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SetFile -->
|
||
|
|
<class name="SetFile" extends="org.apache.hadoop.io.MapFile"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SetFile"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A file-based set of keys.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SetFile -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SetFile.Reader -->
|
||
|
|
<class name="SetFile.Reader" extends="org.apache.hadoop.io.MapFile.Reader"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SetFile.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 a set reader for the named set.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SetFile.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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a set reader for the named set using the named comparator.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="seek" 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"/>
|
||
|
|
</method>
|
||
|
|
<method name="next" 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[Read the next key in a set into <code>key</code>. Returns
|
||
|
|
true if such a key exists and false when at the end of the set.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="get" return="org.apache.hadoop.io.WritableComparable"
|
||
|
|
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[Read the matching key from a set into <code>key</code>.
|
||
|
|
Returns <code>key</code>, or null if no match exists.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Provide access to an existing set file.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SetFile.Reader -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SetFile.Writer -->
|
||
|
|
<class name="SetFile.Writer" extends="org.apache.hadoop.io.MapFile.Writer"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SetFile.Writer" type="org.apache.hadoop.fs.FileSystem, java.lang.String, java.lang.Class"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="pass a Configuration too">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create the named set for keys of the named class.
|
||
|
|
@deprecated pass a Configuration too]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SetFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, 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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a set naming the element class and compression type.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SetFile.Writer" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileSystem, java.lang.String, org.apache.hadoop.io.WritableComparator, org.apache.hadoop.io.SequenceFile.CompressionType"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a set naming the element comparator and compression type.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="append"
|
||
|
|
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[Append a key to a set. The key must be strictly greater than the
|
||
|
|
previous key added to the set.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a new set file.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SetFile.Writer -->
|
||
|
|
<!-- start class org.apache.hadoop.io.SortedMapWritable -->
|
||
|
|
<class name="SortedMapWritable" extends="org.apache.hadoop.io.AbstractMapWritable"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.util.SortedMap"/>
|
||
|
|
<constructor name="SortedMapWritable"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[default constructor.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SortedMapWritable" type="org.apache.hadoop.io.SortedMapWritable"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy constructor.
|
||
|
|
|
||
|
|
@param other the map to copy from]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="comparator" return="java.util.Comparator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="firstKey" return="org.apache.hadoop.io.WritableComparable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="headMap" return="java.util.SortedMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="lastKey" return="org.apache.hadoop.io.WritableComparable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="subMap" return="java.util.SortedMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<param name="toKey" type="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="tailMap" return="java.util.SortedMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fromKey" type="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<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.WritableComparable"/>
|
||
|
|
<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="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>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A Writable SortedMap.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.SortedMapWritable -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.Stringifier -->
|
||
|
|
<interface name="Stringifier" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Converts the object to a string representation
|
||
|
|
@param obj the object to convert
|
||
|
|
@return the string representation of the object
|
||
|
|
@throws IOException if the object cannot be converted]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Restores the object from its string representation.
|
||
|
|
@param str the string representation of the object
|
||
|
|
@return restored object
|
||
|
|
@throws IOException if the object cannot be restored]]>
|
||
|
|
</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[Closes this object.
|
||
|
|
@throws IOException if an I/O error occurs]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stringifier interface offers two methods to convert an object
|
||
|
|
to a string representation and restore the object given its
|
||
|
|
string representation.
|
||
|
|
@param <T> the class of the objects to stringify]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.Stringifier -->
|
||
|
|
<!-- start class org.apache.hadoop.io.Text -->
|
||
|
|
<class name="Text" 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="Text"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Text" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct from a string.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Text" type="org.apache.hadoop.io.Text"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct from another text.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Text" type="byte[]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getBytes" return="byte[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the raw bytes; however, only data up to {@link #getLength()} is
|
||
|
|
valid.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLength" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the number of bytes in the byte array]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="charAt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="position" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the Unicode Scalar Value (32-bit integer value)
|
||
|
|
for the character at <code>position</code>. Note that this
|
||
|
|
method avoids using the converter or doing String instatiation
|
||
|
|
@return the Unicode scalar value at position or -1
|
||
|
|
if the position is invalid or points to a
|
||
|
|
trailing byte]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="find" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="what" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<method name="find" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="what" type="java.lang.String"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Finds any occurence of <code>what</code> in the backing
|
||
|
|
buffer, starting as position <code>start</code>. The starting
|
||
|
|
position is measured in bytes and the return value is in
|
||
|
|
terms of byte position in the buffer. The backing buffer is
|
||
|
|
not converted to a string for this operation.
|
||
|
|
@return byte position of the first occurence of the search
|
||
|
|
string in the UTF-8 buffer or -1 if not found]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="string" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set to contain the contents of a string.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set to a utf8 byte array]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="other" type="org.apache.hadoop.io.Text"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[copy a text.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Set the Text to range of bytes
|
||
|
|
@param utf8 the data to copy from
|
||
|
|
@param start the first position of the new string
|
||
|
|
@param len the number of bytes of the new string]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Append a range of bytes to the end of the given text
|
||
|
|
@param utf8 the data to copy from
|
||
|
|
@param start the first position to append from utf8
|
||
|
|
@param len the number of bytes to append]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="clear"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Clear the string to empty.]]>
|
||
|
|
</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[Convert text back to string
|
||
|
|
@see java.lang.Object#toString()]]>
|
||
|
|
</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[deserialize]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="skip"
|
||
|
|
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[Skips over one Text in the input.]]>
|
||
|
|
</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[serialize
|
||
|
|
write this object to out
|
||
|
|
length uses zero-compressed encoding
|
||
|
|
@see Writable#write(DataOutput)]]>
|
||
|
|
</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 a Text with the same contents.]]>
|
||
|
|
</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="decode" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Converts the provided byte array to a String using the
|
||
|
|
UTF-8 encoding. If the input is malformed,
|
||
|
|
replace by a default value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="decode" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
|
||
|
|
</method>
|
||
|
|
<method name="decode" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<param name="replace" type="boolean"/>
|
||
|
|
<exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Converts the provided byte array to a String using the
|
||
|
|
UTF-8 encoding. If <code>replace</code> is true, then
|
||
|
|
malformed input is replaced with the
|
||
|
|
substitution character, which is U+FFFD. Otherwise the
|
||
|
|
method throws a MalformedInputException.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="encode" return="java.nio.ByteBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="string" type="java.lang.String"/>
|
||
|
|
<exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Converts the provided String to bytes using the
|
||
|
|
UTF-8 encoding. If the input is malformed,
|
||
|
|
invalid chars are replaced by a default value.
|
||
|
|
@return ByteBuffer: bytes stores at ByteBuffer.array()
|
||
|
|
and length is ByteBuffer.limit()]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="encode" return="java.nio.ByteBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="string" type="java.lang.String"/>
|
||
|
|
<param name="replace" type="boolean"/>
|
||
|
|
<exception name="CharacterCodingException" type="java.nio.charset.CharacterCodingException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Converts the provided String to bytes using the
|
||
|
|
UTF-8 encoding. If <code>replace</code> is true, then
|
||
|
|
malformed input is replaced with the
|
||
|
|
substitution character, which is U+FFFD. Otherwise the
|
||
|
|
method throws a MalformedInputException.
|
||
|
|
@return ByteBuffer: bytes stores at ByteBuffer.array()
|
||
|
|
and length is ByteBuffer.limit()]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
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[Read a UTF8 encoded string from in]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeString" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a UTF8 encoded string to out]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="validateUTF8"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check if a byte array contains valid utf-8
|
||
|
|
@param utf8 byte array
|
||
|
|
@throws MalformedInputException if the byte array contains invalid utf-8]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="validateUTF8"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="utf8" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<exception name="MalformedInputException" type="java.nio.charset.MalformedInputException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check to see if a byte array is valid utf-8
|
||
|
|
@param utf8 the array of bytes
|
||
|
|
@param start the offset of the first byte in the array
|
||
|
|
@param len the length of the byte sequence
|
||
|
|
@throws MalformedInputException if the byte array contains invalid bytes]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="bytesToCodePoint" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="java.nio.ByteBuffer"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the next code point at the current position in
|
||
|
|
the buffer. The buffer's position will be incremented.
|
||
|
|
Any mark set on this buffer will be changed by this method!]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="utf8Length" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="string" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[For the given string, returns the number of UTF-8 bytes
|
||
|
|
required to encode the string.
|
||
|
|
@param string text to encode
|
||
|
|
@return number of UTF-8 bytes required to encode]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class stores text using standard UTF8 encoding. It provides methods
|
||
|
|
to serialize, deserialize, and compare texts at byte level. The type of
|
||
|
|
length is integer and is serialized using zero-compressed format. <p>In
|
||
|
|
addition, it provides methods for string traversal without converting the
|
||
|
|
byte array to a string. <p>Also includes utilities for
|
||
|
|
serializing/deserialing a string, coding/decoding a string, checking if a
|
||
|
|
byte array contains valid UTF8 code, calculating the length of an encoded
|
||
|
|
string.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.Text -->
|
||
|
|
<!-- start class org.apache.hadoop.io.Text.Comparator -->
|
||
|
|
<class name="Text.Comparator" extends="org.apache.hadoop.io.WritableComparator"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="Text.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 Text keys.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.Text.Comparator -->
|
||
|
|
<!-- start class org.apache.hadoop.io.TwoDArrayWritable -->
|
||
|
|
<class name="TwoDArrayWritable" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="TwoDArrayWritable" type="java.lang.Class"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="TwoDArrayWritable" type="java.lang.Class, org.apache.hadoop.io.Writable[][]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<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 2D arrays containing a matrix of instances of a class.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.TwoDArrayWritable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.UTF8.Comparator -->
|
||
|
|
<class name="UTF8.Comparator" extends="org.apache.hadoop.io.WritableComparator"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="UTF8.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 UTF8 keys.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.UTF8.Comparator -->
|
||
|
|
<!-- start class org.apache.hadoop.io.VersionedWritable -->
|
||
|
|
<class name="VersionedWritable" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<constructor name="VersionedWritable"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getVersion" return="byte"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the version number of the current implementation.]]>
|
||
|
|
</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[A base class for Writables that provides version checking.
|
||
|
|
|
||
|
|
<p>This is useful when a class may evolve, so that instances written by the
|
||
|
|
old version of the class may still be processed by the new version. To
|
||
|
|
handle this situation, {@link #readFields(DataInput)}
|
||
|
|
implementations should catch {@link VersionMismatchException}.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.VersionedWritable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.VersionMismatchException -->
|
||
|
|
<class name="VersionMismatchException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="VersionMismatchException" type="byte, byte"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<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>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Thrown by {@link VersionedWritable#readFields(DataInput)} when the
|
||
|
|
version of an object being read does not match the current implementation
|
||
|
|
version as returned by {@link VersionedWritable#getVersion()}.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.VersionMismatchException -->
|
||
|
|
<!-- start class org.apache.hadoop.io.VIntWritable -->
|
||
|
|
<class name="VIntWritable" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<constructor name="VIntWritable"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="VIntWritable" 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 VIntWritable.]]>
|
||
|
|
</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 VIntWritable.]]>
|
||
|
|
</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 VIntWritable 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 VIntWritables.]]>
|
||
|
|
</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 integer values stored in variable-length format.
|
||
|
|
Such values take between one and five bytes. Smaller values take fewer bytes.
|
||
|
|
|
||
|
|
@see org.apache.hadoop.io.WritableUtils#readVInt(DataInput)]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.VIntWritable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.VLongWritable -->
|
||
|
|
<class name="VLongWritable" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<constructor name="VLongWritable"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="VLongWritable" 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 VLongWritable 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 VLongWritables.]]>
|
||
|
|
</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 in a variable-length format. Such values take
|
||
|
|
between one and five bytes. Smaller values take fewer bytes.
|
||
|
|
|
||
|
|
@see org.apache.hadoop.io.WritableUtils#readVLong(DataInput)]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.VLongWritable -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.Writable -->
|
||
|
|
<interface name="Writable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<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[Serialize the fields of this object to <code>out</code>.
|
||
|
|
|
||
|
|
@param out <code>DataOuput</code> to serialize this object into.
|
||
|
|
@throws IOException]]>
|
||
|
|
</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[Deserialize the fields of this object from <code>in</code>.
|
||
|
|
|
||
|
|
<p>For efficiency, implementations should attempt to re-use storage in the
|
||
|
|
existing object where possible.</p>
|
||
|
|
|
||
|
|
@param in <code>DataInput</code> to deseriablize this object from.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A serializable object which implements a simple, efficient, serialization
|
||
|
|
protocol, based on {@link DataInput} and {@link DataOutput}.
|
||
|
|
|
||
|
|
<p>Any <code>key</code> or <code>value</code> type in the Hadoop Map-Reduce
|
||
|
|
framework implements this interface.</p>
|
||
|
|
|
||
|
|
<p>Implementations typically implement a static <code>read(DataInput)</code>
|
||
|
|
method which constructs a new instance, calls {@link #readFields(DataInput)}
|
||
|
|
and returns the instance.</p>
|
||
|
|
|
||
|
|
<p>Example:</p>
|
||
|
|
<p><blockquote><pre>
|
||
|
|
public class MyWritable implements Writable {
|
||
|
|
// Some data
|
||
|
|
private int counter;
|
||
|
|
private long timestamp;
|
||
|
|
|
||
|
|
public void write(DataOutput out) throws IOException {
|
||
|
|
out.writeInt(counter);
|
||
|
|
out.writeLong(timestamp);
|
||
|
|
}
|
||
|
|
|
||
|
|
public void readFields(DataInput in) throws IOException {
|
||
|
|
counter = in.readInt();
|
||
|
|
timestamp = in.readLong();
|
||
|
|
}
|
||
|
|
|
||
|
|
public static MyWritable read(DataInput in) throws IOException {
|
||
|
|
MyWritable w = new MyWritable();
|
||
|
|
w.readFields(in);
|
||
|
|
return w;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</pre></blockquote></p>]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.Writable -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.WritableComparable -->
|
||
|
|
<interface name="WritableComparable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.Writable"/>
|
||
|
|
<implements name="java.lang.Comparable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A {@link Writable} which is also {@link Comparable}.
|
||
|
|
|
||
|
|
<p><code>WritableComparable</code>s can be compared to each other, typically
|
||
|
|
via <code>Comparator</code>s. Any type which is to be used as a
|
||
|
|
<code>key</code> in the Hadoop Map-Reduce framework should implement this
|
||
|
|
interface.</p>
|
||
|
|
|
||
|
|
<p>Example:</p>
|
||
|
|
<p><blockquote><pre>
|
||
|
|
public class MyWritableComparable implements
|
||
|
|
WritableComparable<MyWritableComparable> {
|
||
|
|
|
||
|
|
// Some data
|
||
|
|
private int counter;
|
||
|
|
private long timestamp;
|
||
|
|
|
||
|
|
public void write(DataOutput out) throws IOException {
|
||
|
|
out.writeInt(counter);
|
||
|
|
out.writeLong(timestamp);
|
||
|
|
}
|
||
|
|
|
||
|
|
public void readFields(DataInput in) throws IOException {
|
||
|
|
counter = in.readInt();
|
||
|
|
timestamp = in.readLong();
|
||
|
|
}
|
||
|
|
|
||
|
|
public int compareTo(MyWritableComparable other) {
|
||
|
|
int thisValue = this.counter;
|
||
|
|
int thatValue = other.counter;
|
||
|
|
return (thisValue < thatValue ? -1 : (thisValue == thatValue ? 0 : 1));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</pre></blockquote></p>]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.WritableComparable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.WritableComparator -->
|
||
|
|
<class name="WritableComparator" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.RawComparator"/>
|
||
|
|
<constructor name="WritableComparator" type="java.lang.Class"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct for a {@link WritableComparable} implementation.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="WritableComparator" type="java.lang.Class, boolean"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="get" return="org.apache.hadoop.io.WritableComparator"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a comparator for a {@link WritableComparable} implementation.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="define"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<param name="comparator" type="org.apache.hadoop.io.WritableComparator"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Register an optimized comparator for a {@link WritableComparable}
|
||
|
|
implementation.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<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 WritableComparable implementation class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newKey" return="org.apache.hadoop.io.WritableComparable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a new {@link WritableComparable} instance.]]>
|
||
|
|
</doc>
|
||
|
|
</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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Optimization hook. Override this to make SequenceFile.Sorter's scream.
|
||
|
|
|
||
|
|
<p>The default implementation reads the data into two {@link
|
||
|
|
WritableComparable}s (using {@link
|
||
|
|
Writable#readFields(DataInput)}, then calls {@link
|
||
|
|
#compare(WritableComparable,WritableComparable)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compare two WritableComparables.
|
||
|
|
|
||
|
|
<p> The default implementation uses the natural ordering, calling {@link
|
||
|
|
Comparable#compareTo(Object)}.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compare" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="a" type="java.lang.Object"/>
|
||
|
|
<param name="b" type="java.lang.Object"/>
|
||
|
|
</method>
|
||
|
|
<method name="compareBytes" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" 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[Lexicographic order of binary data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashBytes" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compute hash for binary data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashBytes" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compute hash for binary data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readUnsignedShort" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse an unsigned short from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse an integer from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse a float from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse a long from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse a double from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
|
||
|
|
@param bytes byte array with decode long
|
||
|
|
@param start starting index
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized long]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
|
||
|
|
@param bytes byte array with the encoded integer
|
||
|
|
@param start start index
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized integer]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A Comparator for {@link WritableComparable}s.
|
||
|
|
|
||
|
|
<p>This base implemenation uses the natural ordering. To define alternate
|
||
|
|
orderings, override {@link #compare(WritableComparable,WritableComparable)}.
|
||
|
|
|
||
|
|
<p>One may optimize compare-intensive operations by overriding
|
||
|
|
{@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are
|
||
|
|
provided to assist in optimized implementations of this method.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.WritableComparator -->
|
||
|
|
<!-- start class org.apache.hadoop.io.WritableFactories -->
|
||
|
|
<class name="WritableFactories" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="setFactory"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.io.WritableFactory"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Define a factory for a class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFactory" return="org.apache.hadoop.io.WritableFactory"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Define a factory for a class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newInstance" return="org.apache.hadoop.io.Writable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a new instance of a class with a defined factory.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newInstance" return="org.apache.hadoop.io.Writable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a new instance of a class with a defined factory.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Factories for non-public writables. Defining a factory permits {@link
|
||
|
|
ObjectWritable} to be able to construct instances of non-public classes.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.WritableFactories -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.WritableFactory -->
|
||
|
|
<interface name="WritableFactory" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="newInstance" return="org.apache.hadoop.io.Writable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return a new instance.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A factory for a class of Writable.
|
||
|
|
@see WritableFactories]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.WritableFactory -->
|
||
|
|
<!-- start class org.apache.hadoop.io.WritableUtils -->
|
||
|
|
<class name="WritableUtils" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="WritableUtils"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="readCompressedByteArray" return="byte[]"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="skipCompressedByteArray"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeCompressedByteArray" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readCompressedString" return="java.lang.String"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeCompressedString" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeStringArray"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeCompressedStringArray"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readStringArray" return="java.lang.String[]"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="readCompressedStringArray" return="java.lang.String[]"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="displayByteArray"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="byte[]"/>
|
||
|
|
</method>
|
||
|
|
<method name="clone" return="T"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="orig" type="T"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Make a copy of a writable object using serialization to a buffer.
|
||
|
|
@param orig The object to copy
|
||
|
|
@return The copied object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="cloneInto"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="use ReflectionUtils.cloneInto instead.">
|
||
|
|
<param name="dst" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<param name="src" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Make a copy of the writable object using serialiation to a buffer
|
||
|
|
@param dst the object to copy from
|
||
|
|
@param src the object to copy into, which is destroyed
|
||
|
|
@throws IOException
|
||
|
|
@deprecated use ReflectionUtils.cloneInto instead.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeVInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataOutput"/>
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serializes an integer to a binary stream with zero-compressed encoding.
|
||
|
|
For -120 <= i <= 127, only one byte is used with the actual value.
|
||
|
|
For other values of i, the first byte value indicates whether the
|
||
|
|
integer is positive or negative, and the number of bytes that follow.
|
||
|
|
If the first byte value v is between -121 and -124, the following integer
|
||
|
|
is positive, with number of bytes that follow are -(v+120).
|
||
|
|
If the first byte value v is between -125 and -128, the following integer
|
||
|
|
is negative, with number of bytes that follow are -(v+124). Bytes are
|
||
|
|
stored in the high-non-zero-byte-first order.
|
||
|
|
|
||
|
|
@param stream Binary output stream
|
||
|
|
@param i Integer to be serialized
|
||
|
|
@throws java.io.IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeVLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataOutput"/>
|
||
|
|
<param name="i" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
|
||
|
|
For -112 <= i <= 127, only one byte is used with the actual value.
|
||
|
|
For other values of i, the first byte value indicates whether the
|
||
|
|
long is positive or negative, and the number of bytes that follow.
|
||
|
|
If the first byte value v is between -113 and -120, the following long
|
||
|
|
is positive, with number of bytes that follow are -(v+112).
|
||
|
|
If the first byte value v is between -121 and -128, the following long
|
||
|
|
is negative, with number of bytes that follow are -(v+120). Bytes are
|
||
|
|
stored in the high-non-zero-byte-first order.
|
||
|
|
|
||
|
|
@param stream Binary output stream
|
||
|
|
@param i Long to be serialized
|
||
|
|
@throws java.io.IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded long from input stream and returns it.
|
||
|
|
@param stream Binary input stream
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized long from stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded integer from input stream and returns it.
|
||
|
|
@param stream Binary input stream
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized integer from stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isNegativeVInt" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="value" type="byte"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Given the first byte of a vint/vlong, determine the sign
|
||
|
|
@param value the first byte
|
||
|
|
@return is the value negative]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="decodeVIntSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="value" type="byte"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse the first byte of a vint/vlong to determine the number of bytes
|
||
|
|
@param value the first byte of the vint/vlong
|
||
|
|
@return the total number of bytes (1 to 9)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getVIntSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the encoded length if an integer is stored in a variable-length format
|
||
|
|
@return the encoded length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readEnum" return="T"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.DataInput"/>
|
||
|
|
<param name="enumType" type="java.lang.Class"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read an Enum value from DataInput, Enums are read and written
|
||
|
|
using String values.
|
||
|
|
@param <T> Enum type
|
||
|
|
@param in DataInput to read from
|
||
|
|
@param enumType Class type of Enum
|
||
|
|
@return Enum represented by String read from DataInput
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeEnum"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="enumVal" type="java.lang.Enum"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[writes String value of enum to DataOutput.
|
||
|
|
@param out Dataoutput stream
|
||
|
|
@param enumVal enum value
|
||
|
|
@throws IOException]]>
|
||
|
|
</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.DataInput"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Skip <i>len</i> number of bytes in input stream<i>in</i>
|
||
|
|
@param in input stream
|
||
|
|
@param len number of bytes to skip
|
||
|
|
@throws IOException when skipped less number of bytes]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="toByteArray" return="byte[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="writables" type="org.apache.hadoop.io.Writable[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Convert writables to a byte array]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readStringSafely" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.DataInput"/>
|
||
|
|
<param name="maxLength" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a string, but check it for sanity. The format consists of a vint
|
||
|
|
followed by the given number of bytes.
|
||
|
|
@param in the stream to read from
|
||
|
|
@param maxLength the largest acceptable length of the encoded string
|
||
|
|
@return the bytes as a string
|
||
|
|
@throws IOException if reading from the DataInput fails
|
||
|
|
@throws IllegalArgumentException if the encoded byte size for string
|
||
|
|
is negative or larger than maxSize. Only the vint is read.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.WritableUtils -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Generic i/o code for use when reading and writing data to the network,
|
||
|
|
to databases, and to files.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.io.compress">
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.BlockCompressorStream -->
|
||
|
|
<class name="BlockCompressorStream" extends="org.apache.hadoop.io.compress.CompressorStream"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link BlockCompressorStream}.
|
||
|
|
|
||
|
|
@param out stream
|
||
|
|
@param compressor compressor to be used
|
||
|
|
@param bufferSize size of buffer
|
||
|
|
@param compressionOverhead maximum 'overhead' of the compression
|
||
|
|
algorithm with given bufferSize]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BlockCompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link BlockCompressorStream} with given output-stream and
|
||
|
|
compressor.
|
||
|
|
Use default of 512 as bufferSize and compressionOverhead of
|
||
|
|
(1% of bufferSize + 12 bytes) = 18 bytes (zlib algorithm).
|
||
|
|
|
||
|
|
@param out stream
|
||
|
|
@param compressor compressor to be used]]>
|
||
|
|
</doc>
|
||
|
|
</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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write the data provided to the compression codec, compressing no more
|
||
|
|
than the buffer size less the compression overhead as specified during
|
||
|
|
construction for each block.
|
||
|
|
|
||
|
|
Each block contains the uncompressed length for the block, followed by
|
||
|
|
one or more length-prefixed blocks of compressed data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="finish"
|
||
|
|
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="compress"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A {@link org.apache.hadoop.io.compress.CompressorStream} which works
|
||
|
|
with 'block-based' based compression algorithms, as opposed to
|
||
|
|
'stream-based' compression algorithms.
|
||
|
|
|
||
|
|
It should be noted that this wrapper does not guarantee that blocks will
|
||
|
|
be sized for the compressor. If the
|
||
|
|
{@link org.apache.hadoop.io.compress.Compressor} requires buffering to
|
||
|
|
effect meaningful compression, it is responsible for it.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.BlockCompressorStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.BlockDecompressorStream -->
|
||
|
|
<class name="BlockDecompressorStream" extends="org.apache.hadoop.io.compress.DecompressorStream"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link BlockDecompressorStream}.
|
||
|
|
|
||
|
|
@param in input stream
|
||
|
|
@param decompressor decompressor to use
|
||
|
|
@param bufferSize size of buffer
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BlockDecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link BlockDecompressorStream}.
|
||
|
|
|
||
|
|
@param in input stream
|
||
|
|
@param decompressor decompressor to use
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BlockDecompressorStream" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<method name="decompress" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
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="getCompressedData"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="resetState"
|
||
|
|
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[A {@link org.apache.hadoop.io.compress.DecompressorStream} which works
|
||
|
|
with 'block-based' based compression algorithms, as opposed to
|
||
|
|
'stream-based' compression algorithms.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.BlockDecompressorStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.BZip2Codec -->
|
||
|
|
<class name="BZip2Codec" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.compress.SplittableCompressionCodec"/>
|
||
|
|
<constructor name="BZip2Codec"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of BZip2Codec]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
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[Creates CompressionOutputStream for BZip2
|
||
|
|
|
||
|
|
@param out
|
||
|
|
The output Stream
|
||
|
|
@return The BZip2 CompressionOutputStream
|
||
|
|
@throws java.io.IOException
|
||
|
|
Throws IO exception]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.OutputStream"/>
|
||
|
|
<param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a compressor using given OutputStream.
|
||
|
|
|
||
|
|
@return CompressionOutputStream
|
||
|
|
@throws java.io.IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This functionality is currently not supported.
|
||
|
|
|
||
|
|
@return BZip2DummyCompressor.class]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This functionality is currently not supported.
|
||
|
|
|
||
|
|
@return Compressor]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates CompressionInputStream to be used to read off uncompressed data.
|
||
|
|
|
||
|
|
@param in
|
||
|
|
The InputStream
|
||
|
|
@return Returns CompressionInputStream for BZip2
|
||
|
|
@throws java.io.IOException
|
||
|
|
Throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This functionality is currently not supported.
|
||
|
|
|
||
|
|
@return CompressionInputStream]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="seekableIn" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<param name="start" type="long"/>
|
||
|
|
<param name="end" type="long"/>
|
||
|
|
<param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates CompressionInputStream to be used to read off uncompressed data
|
||
|
|
in one of the two reading modes. i.e. Continuous or Blocked reading modes
|
||
|
|
|
||
|
|
@param seekableIn The InputStream
|
||
|
|
@param start The start offset into the compressed stream
|
||
|
|
@param end The end offset into the compressed stream
|
||
|
|
@param readMode Controls whether progress is reported continuously or
|
||
|
|
only at block boundaries.
|
||
|
|
|
||
|
|
@return CompressionInputStream for BZip2 aligned at block boundaries]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDecompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This functionality is currently not supported.
|
||
|
|
|
||
|
|
@return BZip2DummyDecompressor.class]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This functionality is currently not supported.
|
||
|
|
|
||
|
|
@return Decompressor]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDefaultExtension" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[.bz2 is recognized as the default extension for compressed BZip2 files
|
||
|
|
|
||
|
|
@return A String telling the default bzip2 file extension]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class provides CompressionOutputStream and CompressionInputStream for
|
||
|
|
compression and decompression. Currently we dont have an implementation of
|
||
|
|
the Compressor and Decompressor interfaces, so those methods of
|
||
|
|
CompressionCodec which have a Compressor or Decompressor type argument, throw
|
||
|
|
UnsupportedOperationException.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.BZip2Codec -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.CodecPool -->
|
||
|
|
<class name="CodecPool" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CodecPool"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a {@link Compressor} for the given {@link CompressionCodec} from the
|
||
|
|
pool or a new one.
|
||
|
|
|
||
|
|
@param codec the <code>CompressionCodec</code> for which to get the
|
||
|
|
<code>Compressor</code>
|
||
|
|
@param conf the <code>Configuration</code> object which contains confs for creating or reinit the compressor
|
||
|
|
@return <code>Compressor</code> for the given
|
||
|
|
<code>CompressionCodec</code> from the pool or a new one]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
</method>
|
||
|
|
<method name="getDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="codec" type="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a {@link Decompressor} for the given {@link CompressionCodec} from the
|
||
|
|
pool or a new one.
|
||
|
|
|
||
|
|
@param codec the <code>CompressionCodec</code> for which to get the
|
||
|
|
<code>Decompressor</code>
|
||
|
|
@return <code>Decompressor</code> for the given
|
||
|
|
<code>CompressionCodec</code> the pool or a new one]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="returnCompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the {@link Compressor} to the pool.
|
||
|
|
|
||
|
|
@param compressor the <code>Compressor</code> to be returned to the pool]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="returnDecompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the {@link Decompressor} to the pool.
|
||
|
|
|
||
|
|
@param decompressor the <code>Decompressor</code> to be returned to the
|
||
|
|
pool]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A global compressor/decompressor pool used to save and reuse
|
||
|
|
(possibly native) compression/decompression codecs.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.CodecPool -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.compress.CompressionCodec -->
|
||
|
|
<interface name="CompressionCodec" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
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[Create a {@link CompressionOutputStream} that will write to the given
|
||
|
|
{@link OutputStream}.
|
||
|
|
|
||
|
|
@param out the location for the final output stream
|
||
|
|
@return a stream the user can write uncompressed data to have it compressed
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.OutputStream"/>
|
||
|
|
<param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link CompressionOutputStream} that will write to the given
|
||
|
|
{@link OutputStream} with the given {@link Compressor}.
|
||
|
|
|
||
|
|
@param out the location for the final output stream
|
||
|
|
@param compressor compressor to use
|
||
|
|
@return a stream the user can write uncompressed data to have it compressed
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the type of {@link Compressor} needed by this {@link CompressionCodec}.
|
||
|
|
|
||
|
|
@return the type of compressor needed by this codec.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a new {@link Compressor} for use by this {@link CompressionCodec}.
|
||
|
|
|
||
|
|
@return a new compressor for use by this codec]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a stream decompressor that will read from the given input stream.
|
||
|
|
|
||
|
|
@param in the stream to read compressed bytes from
|
||
|
|
@return a stream to read uncompressed bytes from
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a {@link CompressionInputStream} that will read from the given
|
||
|
|
{@link InputStream} with the given {@link Decompressor}.
|
||
|
|
|
||
|
|
@param in the stream to read compressed bytes from
|
||
|
|
@param decompressor decompressor to use
|
||
|
|
@return a stream to read uncompressed bytes from
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDecompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the type of {@link Decompressor} needed by this {@link CompressionCodec}.
|
||
|
|
|
||
|
|
@return the type of decompressor needed by this codec.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a new {@link Decompressor} for use by this {@link CompressionCodec}.
|
||
|
|
|
||
|
|
@return a new decompressor for use by this codec]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getDefaultExtension" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the default filename extension for this kind of compression.
|
||
|
|
@return the extension including the '.']]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class encapsulates a streaming compression/decompression pair.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.compress.CompressionCodec -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.CompressionCodecFactory -->
|
||
|
|
<class name="CompressionCodecFactory" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CompressionCodecFactory" type="org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Find the codecs specified in the config value io.compression.codecs
|
||
|
|
and register them. Defaults to gzip and zip.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Print the extension map out as a string.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCodecClasses" return="java.util.List"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the list of codecs listed in the configuration
|
||
|
|
@param conf the configuration to look in
|
||
|
|
@return a list of the Configuration classes or null if the attribute
|
||
|
|
was not set]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setCodecClasses"
|
||
|
|
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="classes" type="java.util.List"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets a list of codec classes in the configuration.
|
||
|
|
@param conf the configuration to modify
|
||
|
|
@param classes the list of classes to set]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCodec" return="org.apache.hadoop.io.compress.CompressionCodec"
|
||
|
|
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[Find the relevant compression codec for the given file based on its
|
||
|
|
filename suffix.
|
||
|
|
@param file the filename to check
|
||
|
|
@return the codec object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="removeSuffix" 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"/>
|
||
|
|
<param name="suffix" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Removes a suffix from a filename, if it has it.
|
||
|
|
@param filename the filename to strip
|
||
|
|
@param suffix the suffix to remove
|
||
|
|
@return the shortened filename]]>
|
||
|
|
</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[A little test program.
|
||
|
|
@param args]]>
|
||
|
|
</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>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A factory that will find the correct codec for a given filename.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.CompressionCodecFactory -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.CompressionInputStream -->
|
||
|
|
<class name="CompressionInputStream" extends="java.io.InputStream"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.fs.Seekable"/>
|
||
|
|
<constructor name="CompressionInputStream" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a compression input stream that reads
|
||
|
|
the decompressed bytes from the given stream.
|
||
|
|
|
||
|
|
@param in The input stream to be compressed.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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="read" return="int"
|
||
|
|
abstract="true" 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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read bytes from the stream.
|
||
|
|
Made abstract to prevent leakage to underlying stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="resetState"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reset the decompressor to its initial state and discard any buffered data,
|
||
|
|
as the underlying stream may have been repositioned.]]>
|
||
|
|
</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[This method returns the current position in the stream.
|
||
|
|
|
||
|
|
@return Current position in stream as a long]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<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="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This method is current not supported.
|
||
|
|
|
||
|
|
@throws UnsupportedOperationException]]>
|
||
|
|
</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="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This method is current not supported.
|
||
|
|
|
||
|
|
@throws UnsupportedOperationException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="in" type="java.io.InputStream"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The input stream to be compressed.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="maxAvailableData" type="long"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A compression input stream.
|
||
|
|
|
||
|
|
<p>Implementations are assumed to be buffered. This permits clients to
|
||
|
|
reposition the underlying input stream then call {@link #resetState()},
|
||
|
|
without having to also synchronize client buffers.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.CompressionInputStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.CompressionOutputStream -->
|
||
|
|
<class name="CompressionOutputStream" extends="java.io.OutputStream"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CompressionOutputStream" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a compression output stream that writes
|
||
|
|
the compressed bytes to the given stream.
|
||
|
|
@param out]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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="flush"
|
||
|
|
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="write"
|
||
|
|
abstract="true" 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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write compressed bytes to the stream.
|
||
|
|
Made abstract to prevent leakage to underlying stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="finish"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Finishes writing compressed data to the output stream
|
||
|
|
without closing the underlying stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="resetState"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reset the compression to the initial state.
|
||
|
|
Does not reset the underlying stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="out" type="java.io.OutputStream"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The output stream to be compressed.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A compression output stream.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.CompressionOutputStream -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.compress.Compressor -->
|
||
|
|
<interface name="Compressor" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="setInput"
|
||
|
|
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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets input data for compression.
|
||
|
|
This should be called whenever #needsInput() returns
|
||
|
|
<code>true</code> indicating that more input data is required.
|
||
|
|
|
||
|
|
@param b Input data
|
||
|
|
@param off Start offset
|
||
|
|
@param len Length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="needsInput" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if the input data buffer is empty and
|
||
|
|
#setInput() should be called to provide more input.
|
||
|
|
|
||
|
|
@return <code>true</code> if the input data buffer is empty and
|
||
|
|
#setInput() should be called in order to provide more input.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setDictionary"
|
||
|
|
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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets preset dictionary for compression. A preset dictionary
|
||
|
|
is used when the history buffer can be predetermined.
|
||
|
|
|
||
|
|
@param b Dictionary data bytes
|
||
|
|
@param off Start offset
|
||
|
|
@param len Length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getBytesRead" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return number of uncompressed bytes input so far.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getBytesWritten" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return number of compressed bytes output so far.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="finish"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[When called, indicates that compression should end
|
||
|
|
with the current contents of the input buffer.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="finished" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if the end of the compressed
|
||
|
|
data output stream has been reached.
|
||
|
|
@return <code>true</code> if the end of the compressed
|
||
|
|
data output stream has been reached.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compress" 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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Fills specified buffer with compressed data. Returns actual number
|
||
|
|
of bytes of compressed data. A return value of 0 indicates that
|
||
|
|
needsInput() should be called in order to determine if more input
|
||
|
|
data is required.
|
||
|
|
|
||
|
|
@param b Buffer for the compressed data
|
||
|
|
@param off Start offset of the data
|
||
|
|
@param len Size of the buffer
|
||
|
|
@return The actual number of bytes of compressed data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="reset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Resets compressor so that a new set of input data can be processed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="end"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Closes the compressor and discards any unprocessed input.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="reinit"
|
||
|
|
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[Prepare the compressor to be used in a new stream with settings defined in
|
||
|
|
the given Configuration
|
||
|
|
|
||
|
|
@param conf Configuration from which new setting are fetched]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Specification of a stream-based 'compressor' which can be
|
||
|
|
plugged into a {@link CompressionOutputStream} to compress data.
|
||
|
|
This is modelled after {@link java.util.zip.Deflater}]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.compress.Compressor -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.CompressorStream -->
|
||
|
|
<class name="CompressorStream" extends="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="CompressorStream" type="java.io.OutputStream, org.apache.hadoop.io.compress.Compressor"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="CompressorStream" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Allow derived classes to directly set the underlying stream.
|
||
|
|
|
||
|
|
@param out Underlying output stream.]]>
|
||
|
|
</doc>
|
||
|
|
</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="compress"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="finish"
|
||
|
|
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="resetState"
|
||
|
|
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="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>
|
||
|
|
<field name="compressor" type="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="buffer" type="byte[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="closed" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.CompressorStream -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.compress.Decompressor -->
|
||
|
|
<interface name="Decompressor" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="setInput"
|
||
|
|
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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets input data for decompression.
|
||
|
|
This should be called whenever #needsInput() returns
|
||
|
|
<code>true</code> indicating that more input data is required.
|
||
|
|
|
||
|
|
@param b Input data
|
||
|
|
@param off Start offset
|
||
|
|
@param len Length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="needsInput" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if the input data buffer is empty and
|
||
|
|
#setInput() should be called to provide more input.
|
||
|
|
|
||
|
|
@return <code>true</code> if the input data buffer is empty and
|
||
|
|
#setInput() should be called in order to provide more input.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setDictionary"
|
||
|
|
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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets preset dictionary for compression. A preset dictionary
|
||
|
|
is used when the history buffer can be predetermined.
|
||
|
|
|
||
|
|
@param b Dictionary data bytes
|
||
|
|
@param off Start offset
|
||
|
|
@param len Length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="needsDictionary" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns <code>true</code> if a preset dictionary is needed for decompression.
|
||
|
|
@return <code>true</code> if a preset dictionary is needed for decompression]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="finished" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if the end of the compressed
|
||
|
|
data output stream has been reached.
|
||
|
|
@return <code>true</code> if the end of the compressed
|
||
|
|
data output stream has been reached.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="decompress" 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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Fills specified buffer with uncompressed data. Returns actual number
|
||
|
|
of bytes of uncompressed data. A return value of 0 indicates that
|
||
|
|
#needsInput() should be called in order to determine if more input
|
||
|
|
data is required.
|
||
|
|
|
||
|
|
@param b Buffer for the compressed data
|
||
|
|
@param off Start offset of the data
|
||
|
|
@param len Size of the buffer
|
||
|
|
@return The actual number of bytes of compressed data.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="reset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Resets decompressor so that a new set of input data can be processed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="end"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Closes the decompressor and discards any unprocessed input.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Specification of a stream-based 'de-compressor' which can be
|
||
|
|
plugged into a {@link CompressionInputStream} to compress data.
|
||
|
|
This is modelled after {@link java.util.zip.Inflater}]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.compress.Decompressor -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.DecompressorStream -->
|
||
|
|
<class name="DecompressorStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="DecompressorStream" type="java.io.InputStream, org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="DecompressorStream" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Allow derived classes to directly set the underlying stream.
|
||
|
|
|
||
|
|
@param in Underlying input stream.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="read" return="int"
|
||
|
|
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="b" type="byte[]"/>
|
||
|
|
<param name="off" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="decompress" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
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="getCompressedData"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="checkStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="resetState"
|
||
|
|
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="skip" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="n" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="available" return="int"
|
||
|
|
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="markSupported" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="mark"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="readlimit" type="int"/>
|
||
|
|
</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"/>
|
||
|
|
</method>
|
||
|
|
<field name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="buffer" type="byte[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="eof" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="closed" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.DecompressorStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.DefaultCodec -->
|
||
|
|
<class name="DefaultCodec" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.conf.Configurable"/>
|
||
|
|
<implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<constructor name="DefaultCodec"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</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>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.OutputStream"/>
|
||
|
|
<param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="getCompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="getDecompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getDefaultExtension" 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.io.compress.DefaultCodec -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.GzipCodec -->
|
||
|
|
<class name="GzipCodec" extends="org.apache.hadoop.io.compress.DefaultCodec"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="GzipCodec"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
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"/>
|
||
|
|
</method>
|
||
|
|
<method name="createOutputStream" return="org.apache.hadoop.io.compress.CompressionOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.OutputStream"/>
|
||
|
|
<param name="compressor" type="org.apache.hadoop.io.compress.Compressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createCompressor" return="org.apache.hadoop.io.compress.Compressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getCompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="in" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createDecompressor" return="org.apache.hadoop.io.compress.Decompressor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getDecompressorType" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getDefaultExtension" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class creates gzip compressors/decompressors.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.GzipCodec -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.GzipCodec.GzipInputStream -->
|
||
|
|
<class name="GzipCodec.GzipInputStream" extends="org.apache.hadoop.io.compress.DecompressorStream"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="GzipCodec.GzipInputStream" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="GzipCodec.GzipInputStream" type="org.apache.hadoop.io.compress.DecompressorStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Allow subclasses to directly set the inflater stream.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="available" return="int"
|
||
|
|
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="read" return="int"
|
||
|
|
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="data" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="skip" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="offset" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="resetState"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.GzipCodec.GzipInputStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.GzipCodec.GzipOutputStream -->
|
||
|
|
<class name="GzipCodec.GzipOutputStream" extends="org.apache.hadoop.io.compress.CompressorStream"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="GzipCodec.GzipOutputStream" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="GzipCodec.GzipOutputStream" type="org.apache.hadoop.io.compress.CompressorStream"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Allow children types to put a different type in here.
|
||
|
|
@param out the Deflater stream to use]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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="flush"
|
||
|
|
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="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>
|
||
|
|
<method name="write"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="data" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="finish"
|
||
|
|
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="resetState"
|
||
|
|
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[A bridge that wraps around a DeflaterOutputStream to make it
|
||
|
|
a CompressionOutputStream.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.GzipCodec.GzipOutputStream -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
|
||
|
|
<class name="SplitCompressionInputStream" extends="org.apache.hadoop.io.compress.CompressionInputStream"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SplitCompressionInputStream" type="java.io.InputStream, long, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<method name="setStart"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="start" type="long"/>
|
||
|
|
</method>
|
||
|
|
<method name="setEnd"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="end" type="long"/>
|
||
|
|
</method>
|
||
|
|
<method name="getAdjustedStart" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[After calling createInputStream, the values of start or end
|
||
|
|
might change. So this method can be used to get the new value of start.
|
||
|
|
@return The changed value of start]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getAdjustedEnd" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[After calling createInputStream, the values of start or end
|
||
|
|
might change. So this method can be used to get the new value of end.
|
||
|
|
@return The changed value of end]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An InputStream covering a range of compressed data. The start and end
|
||
|
|
offsets requested by a client may be modified by the codec to fit block
|
||
|
|
boundaries or other algorithm-dependent requirements.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.SplitCompressionInputStream -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
|
||
|
|
<interface name="SplittableCompressionCodec" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.compress.CompressionCodec"/>
|
||
|
|
<method name="createInputStream" return="org.apache.hadoop.io.compress.SplitCompressionInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="seekableIn" type="java.io.InputStream"/>
|
||
|
|
<param name="decompressor" type="org.apache.hadoop.io.compress.Decompressor"/>
|
||
|
|
<param name="start" type="long"/>
|
||
|
|
<param name="end" type="long"/>
|
||
|
|
<param name="readMode" type="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a stream as dictated by the readMode. This method is used when
|
||
|
|
the codecs wants the ability to work with the underlying stream positions.
|
||
|
|
|
||
|
|
@param seekableIn The seekable input stream (seeks in compressed data)
|
||
|
|
@param start The start offset into the compressed stream. May be changed
|
||
|
|
by the underlying codec.
|
||
|
|
@param end The end offset into the compressed stream. May be changed by
|
||
|
|
the underlying codec.
|
||
|
|
@param readMode Controls whether stream position is reported continuously
|
||
|
|
from the compressed stream only only at block boundaries.
|
||
|
|
@return a stream to read uncompressed bytes from]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This interface is meant to be implemented by those compression codecs
|
||
|
|
which are capable to compress / de-compress a stream starting at any
|
||
|
|
arbitrary position.
|
||
|
|
|
||
|
|
Especially the process of de-compressing a stream starting at some arbitrary
|
||
|
|
position is challenging. Most of the codecs are only able to successfully
|
||
|
|
de-compress a stream, if they start from the very beginning till the end.
|
||
|
|
One of the reasons is the stored state at the beginning of the stream which
|
||
|
|
is crucial for de-compression.
|
||
|
|
|
||
|
|
Yet there are few codecs which do not save the whole state at the beginning
|
||
|
|
of the stream and hence can be used to de-compress stream starting at any
|
||
|
|
arbitrary points. This interface is meant to be used by such codecs. Such
|
||
|
|
codecs are highly valuable, especially in the context of Hadoop, because
|
||
|
|
an input compressed file can be split and hence can be worked on by multiple
|
||
|
|
machines in parallel.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.compress.SplittableCompressionCodec -->
|
||
|
|
<!-- start class org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE -->
|
||
|
|
<class name="SplittableCompressionCodec.READ_MODE" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE"
|
||
|
|
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[During decompression, data can be read off from the decompressor in two
|
||
|
|
modes, namely continuous and blocked. Few codecs (e.g. BZip2) are capable
|
||
|
|
of compressing data in blocks and then decompressing the blocks. In
|
||
|
|
Blocked reading mode codecs inform 'end of block' events to its caller.
|
||
|
|
While in continuous mode, the caller of codecs is unaware about the blocks
|
||
|
|
and uncompressed data is spilled out like a continuous stream.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.compress.SplittableCompressionCodec.READ_MODE -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.io.file.tfile">
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
|
||
|
|
<class name="MetaBlockAlreadyExists" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Exception - Meta Block with the same name already exists.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
|
||
|
|
<class name="MetaBlockDoesNotExist" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Exception - No such Meta Block with the given name.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist -->
|
||
|
|
<!-- start interface org.apache.hadoop.io.file.tfile.RawComparable -->
|
||
|
|
<interface name="RawComparable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="buffer" return="byte[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the underlying byte array.
|
||
|
|
|
||
|
|
@return The underlying byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="offset" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the offset of the first byte in the byte array.
|
||
|
|
|
||
|
|
@return The offset of the first byte in the byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="size" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the size of the byte range in the byte array.
|
||
|
|
|
||
|
|
@return The size of the byte range in the byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Interface for objects that can be compared through {@link RawComparator}.
|
||
|
|
This is useful in places where we need a single object reference to specify a
|
||
|
|
range of bytes in a byte array, such as {@link Comparable} or
|
||
|
|
{@link Collections#binarySearch(java.util.List, Object, Comparator)}
|
||
|
|
|
||
|
|
The actual comparison among RawComparable's requires an external
|
||
|
|
RawComparator and it is applications' responsibility to ensure two
|
||
|
|
RawComparable are supposed to be semantically comparable with the same
|
||
|
|
RawComparator.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.file.tfile.RawComparable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.TFile -->
|
||
|
|
<class name="TFile" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="makeComparator" return="java.util.Comparator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Make a raw comparator from a string name.
|
||
|
|
|
||
|
|
@param name
|
||
|
|
Comparator name
|
||
|
|
@return A RawComparable comparator.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getSupportedCompressionAlgorithms" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get names of supported compression algorithms. The names are acceptable by
|
||
|
|
TFile.Writer.
|
||
|
|
|
||
|
|
@return Array of strings, each represents a supported compression
|
||
|
|
algorithm. Currently, the following compression algorithms are
|
||
|
|
supported.
|
||
|
|
<ul>
|
||
|
|
<li>"none" - No compression.
|
||
|
|
<li>"lzo" - LZO compression.
|
||
|
|
<li>"gz" - GZIP compression.
|
||
|
|
</ul>]]>
|
||
|
|
</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[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Dumping the TFile information.
|
||
|
|
|
||
|
|
@param args
|
||
|
|
A list of TFile paths.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="COMPRESSION_GZ" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[compression: gzip]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="COMPRESSION_LZO" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[compression: lzo]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="COMPRESSION_NONE" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[compression: none]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="COMPARATOR_MEMCMP" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[comparator: memcmp]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="COMPARATOR_JCLASS" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[comparator prefix: java class]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A TFile is a container of key-value pairs. Both keys and values are type-less
|
||
|
|
bytes. Keys are restricted to 64KB, value length is not restricted
|
||
|
|
(practically limited to the available disk storage). TFile further provides
|
||
|
|
the following features:
|
||
|
|
<ul>
|
||
|
|
<li>Block Compression.
|
||
|
|
<li>Named meta data blocks.
|
||
|
|
<li>Sorted or unsorted keys.
|
||
|
|
<li>Seek by key or by file offset.
|
||
|
|
</ul>
|
||
|
|
The memory footprint of a TFile includes the following:
|
||
|
|
<ul>
|
||
|
|
<li>Some constant overhead of reading or writing a compressed block.
|
||
|
|
<ul>
|
||
|
|
<li>Each compressed block requires one compression/decompression codec for
|
||
|
|
I/O.
|
||
|
|
<li>Temporary space to buffer the key.
|
||
|
|
<li>Temporary space to buffer the value (for TFile.Writer only). Values are
|
||
|
|
chunk encoded, so that we buffer at most one chunk of user data. By default,
|
||
|
|
the chunk buffer is 1MB. Reading chunked value does not require additional
|
||
|
|
memory.
|
||
|
|
</ul>
|
||
|
|
<li>TFile index, which is proportional to the total number of Data Blocks.
|
||
|
|
The total amount of memory needed to hold the index can be estimated as
|
||
|
|
(56+AvgKeySize)*NumBlocks.
|
||
|
|
<li>MetaBlock index, which is proportional to the total number of Meta
|
||
|
|
Blocks.The total amount of memory needed to hold the index for Meta Blocks
|
||
|
|
can be estimated as (40+AvgMetaBlockName)*NumMetaBlock.
|
||
|
|
</ul>
|
||
|
|
<p>
|
||
|
|
The behavior of TFile can be customized by the following variables through
|
||
|
|
Configuration:
|
||
|
|
<ul>
|
||
|
|
<li><b>tfile.io.chunk.size</b>: Value chunk size. Integer (in bytes). Default
|
||
|
|
to 1MB. Values of the length less than the chunk size is guaranteed to have
|
||
|
|
known value length in read time (See
|
||
|
|
{@link TFile.Reader.Scanner.Entry#isValueLengthKnown()}).
|
||
|
|
<li><b>tfile.fs.output.buffer.size</b>: Buffer size used for
|
||
|
|
FSDataOutputStream. Integer (in bytes). Default to 256KB.
|
||
|
|
<li><b>tfile.fs.input.buffer.size</b>: Buffer size used for
|
||
|
|
FSDataInputStream. Integer (in bytes). Default to 256KB.
|
||
|
|
</ul>
|
||
|
|
<p>
|
||
|
|
Suggestions on performance optimization.
|
||
|
|
<ul>
|
||
|
|
<li>Minimum block size. We recommend a setting of minimum block size between
|
||
|
|
256KB to 1MB for general usage. Larger block size is preferred if files are
|
||
|
|
primarily for sequential access. However, it would lead to inefficient random
|
||
|
|
access (because there are more data to decompress). Smaller blocks are good
|
||
|
|
for random access, but require more memory to hold the block index, and may
|
||
|
|
be slower to create (because we must flush the compressor stream at the
|
||
|
|
conclusion of each data block, which leads to an FS I/O flush). Further, due
|
||
|
|
to the internal caching in Compression codec, the smallest possible block
|
||
|
|
size would be around 20KB-30KB.
|
||
|
|
<li>The current implementation does not offer true multi-threading for
|
||
|
|
reading. The implementation uses FSDataInputStream seek()+read(), which is
|
||
|
|
shown to be much faster than positioned-read call in single thread mode.
|
||
|
|
However, it also means that if multiple threads attempt to access the same
|
||
|
|
TFile (using multiple scanners) simultaneously, the actual I/O is carried out
|
||
|
|
sequentially even if they access different DFS blocks.
|
||
|
|
<li>Compression codec. Use "none" if the data is not very compressable (by
|
||
|
|
compressable, I mean a compression ratio at least 2:1). Generally, use "lzo"
|
||
|
|
as the starting point for experimenting. "gz" overs slightly better
|
||
|
|
compression ratio over "lzo" but requires 4x CPU to compress and 2x CPU to
|
||
|
|
decompress, comparing to "lzo".
|
||
|
|
<li>File system buffering, if the underlying FSDataInputStream and
|
||
|
|
FSDataOutputStream is already adequately buffered; or if applications
|
||
|
|
reads/writes keys and values in large buffers, we can reduce the sizes of
|
||
|
|
input/output buffering in TFile layer by setting the configuration parameters
|
||
|
|
"tfile.fs.input.buffer.size" and "tfile.fs.output.buffer.size".
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Some design rationale behind TFile can be found at <a
|
||
|
|
href=https://issues.apache.org/jira/browse/HADOOP-3315>Hadoop-3315</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.TFile -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader -->
|
||
|
|
<class name="TFile.Reader" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<constructor name="TFile.Reader" type="org.apache.hadoop.fs.FSDataInputStream, long, org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
|
||
|
|
@param fsdis
|
||
|
|
FS input stream of the TFile.
|
||
|
|
@param fileLength
|
||
|
|
The length of TFile. This is required because we have no easy
|
||
|
|
way of knowing the actual size of the input file through the
|
||
|
|
File input stream.
|
||
|
|
@param conf
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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[Close the reader. The state of the Reader object is undefined after
|
||
|
|
close. Calling close() for multiple times has no effect.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getComparatorName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the string representation of the comparator.
|
||
|
|
|
||
|
|
@return If the TFile is not sorted by keys, an empty string will be
|
||
|
|
returned. Otherwise, the actual comparator string that is
|
||
|
|
provided during the TFile creation time will be returned.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isSorted" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Is the TFile sorted?
|
||
|
|
|
||
|
|
@return true if TFile is sorted.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getEntryCount" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the number of key-value pair entries in TFile.
|
||
|
|
|
||
|
|
@return the number of key-value pairs in TFile]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFirstKey" return="org.apache.hadoop.io.file.tfile.RawComparable"
|
||
|
|
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 first key in the TFile.
|
||
|
|
|
||
|
|
@return The first key in the TFile.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getLastKey" return="org.apache.hadoop.io.file.tfile.RawComparable"
|
||
|
|
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 last key in the TFile.
|
||
|
|
|
||
|
|
@return The last key in the TFile.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getEntryComparator" return="java.util.Comparator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a Comparator object to compare Entries. It is useful when you want
|
||
|
|
stores the entries in a collection (such as PriorityQueue) and perform
|
||
|
|
sorting or comparison among entries based on the keys without copying out
|
||
|
|
the key.
|
||
|
|
|
||
|
|
@return An Entry Comparator..]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getComparator" return="java.util.Comparator"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get an instance of the RawComparator that is constructed based on the
|
||
|
|
string comparator representation.
|
||
|
|
|
||
|
|
@return a Comparator that can compare RawComparable's.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMetaBlock" return="java.io.DataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="MetaBlockDoesNotExist" type="org.apache.hadoop.io.file.tfile.MetaBlockDoesNotExist"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stream access to a meta block.``
|
||
|
|
|
||
|
|
@param name
|
||
|
|
The name of the meta block.
|
||
|
|
@return The input stream.
|
||
|
|
@throws IOException
|
||
|
|
on I/O error.
|
||
|
|
@throws MetaBlockDoesNotExist
|
||
|
|
If the meta block with the name does not exist.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getRecordNumNear" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="offset" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the RecordNum for the first key-value pair in a compressed block
|
||
|
|
whose byte offset in the TFile is greater than or equal to the specified
|
||
|
|
offset.
|
||
|
|
|
||
|
|
@param offset
|
||
|
|
the user supplied offset.
|
||
|
|
@return the RecordNum to the corresponding entry. If no such entry
|
||
|
|
exists, it returns the total entry count.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKeyNear" return="org.apache.hadoop.io.file.tfile.RawComparable"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="offset" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a sample key that is within a block whose starting offset is greater
|
||
|
|
than or equal to the specified offset.
|
||
|
|
|
||
|
|
@param offset
|
||
|
|
The file offset.
|
||
|
|
@return the key that fits the requirement; or null if no such key exists
|
||
|
|
(which could happen if the offset is close to the end of the
|
||
|
|
TFile).
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
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 a scanner than can scan the whole TFile.
|
||
|
|
|
||
|
|
@return The scanner object. A valid Scanner is always returned even if
|
||
|
|
the TFile is empty.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScannerByByteRange" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="offset" type="long"/>
|
||
|
|
<param name="length" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a scanner that covers a portion of TFile based on byte offsets.
|
||
|
|
|
||
|
|
@param offset
|
||
|
|
The beginning byte offset in the TFile.
|
||
|
|
@param length
|
||
|
|
The length of the region.
|
||
|
|
@return The actual coverage of the returned scanner tries to match the
|
||
|
|
specified byte-region but always round up to the compression
|
||
|
|
block boundaries. It is possible that the returned scanner
|
||
|
|
contains zero key-value pairs even if length is positive.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Use {@link #createScannerByKey(byte[], byte[])} instead.">
|
||
|
|
<param name="beginKey" type="byte[]"/>
|
||
|
|
<param name="endKey" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a scanner that covers a portion of TFile based on keys.
|
||
|
|
|
||
|
|
@param beginKey
|
||
|
|
Begin key of the scan (inclusive). If null, scan from the first
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@param endKey
|
||
|
|
End key of the scan (exclusive). If null, scan up to the last
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@return The actual coverage of the returned scanner will cover all keys
|
||
|
|
greater than or equal to the beginKey and less than the endKey.
|
||
|
|
@throws IOException
|
||
|
|
|
||
|
|
@deprecated Use {@link #createScannerByKey(byte[], byte[])} instead.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScannerByKey" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="beginKey" type="byte[]"/>
|
||
|
|
<param name="endKey" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a scanner that covers a portion of TFile based on keys.
|
||
|
|
|
||
|
|
@param beginKey
|
||
|
|
Begin key of the scan (inclusive). If null, scan from the first
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@param endKey
|
||
|
|
End key of the scan (exclusive). If null, scan up to the last
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@return The actual coverage of the returned scanner will cover all keys
|
||
|
|
greater than or equal to the beginKey and less than the endKey.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScanner" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Use {@link #createScannerByKey(RawComparable, RawComparable)}
|
||
|
|
instead.">
|
||
|
|
<param name="beginKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
|
||
|
|
<param name="endKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a scanner that covers a specific key range.
|
||
|
|
|
||
|
|
@param beginKey
|
||
|
|
Begin key of the scan (inclusive). If null, scan from the first
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@param endKey
|
||
|
|
End key of the scan (exclusive). If null, scan up to the last
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@return The actual coverage of the returned scanner will cover all keys
|
||
|
|
greater than or equal to the beginKey and less than the endKey.
|
||
|
|
@throws IOException
|
||
|
|
|
||
|
|
@deprecated Use {@link #createScannerByKey(RawComparable, RawComparable)}
|
||
|
|
instead.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScannerByKey" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="beginKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
|
||
|
|
<param name="endKey" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a scanner that covers a specific key range.
|
||
|
|
|
||
|
|
@param beginKey
|
||
|
|
Begin key of the scan (inclusive). If null, scan from the first
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@param endKey
|
||
|
|
End key of the scan (exclusive). If null, scan up to the last
|
||
|
|
key-value entry of the TFile.
|
||
|
|
@return The actual coverage of the returned scanner will cover all keys
|
||
|
|
greater than or equal to the beginKey and less than the endKey.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createScannerByRecordNum" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="beginRecNum" type="long"/>
|
||
|
|
<param name="endRecNum" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a scanner that covers a range of records.
|
||
|
|
|
||
|
|
@param beginRecNum
|
||
|
|
The RecordNum for the first record (inclusive).
|
||
|
|
@param endRecNum
|
||
|
|
The RecordNum for the last record (exclusive). To scan the whole
|
||
|
|
file, either specify endRecNum==-1 or endRecNum==getEntryCount().
|
||
|
|
@return The TFile scanner that covers the specified range of records.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[TFile Reader. Users may only read TFiles by creating TFile.Reader.Scanner.
|
||
|
|
objects. A scanner may scan the whole TFile ({@link Reader#createScanner()}
|
||
|
|
) , a portion of TFile based on byte offsets (
|
||
|
|
{@link Reader#createScannerByByteRange(long, long)}), or a portion of TFile with keys
|
||
|
|
fall in a certain key range (for sorted TFile only,
|
||
|
|
{@link Reader#createScannerByKey(byte[], byte[])} or
|
||
|
|
{@link Reader#createScannerByKey(RawComparable, RawComparable)}).]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner -->
|
||
|
|
<class name="TFile.Reader.Scanner" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<constructor name="TFile.Reader.Scanner" type="org.apache.hadoop.io.file.tfile.TFile.Reader, long, long"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
|
||
|
|
@param reader
|
||
|
|
The TFile reader object.
|
||
|
|
@param offBegin
|
||
|
|
Begin byte-offset of the scan.
|
||
|
|
@param offEnd
|
||
|
|
End byte-offset of the scan.
|
||
|
|
@throws IOException
|
||
|
|
|
||
|
|
The offsets will be rounded to the beginning of a compressed
|
||
|
|
block whose offset is greater than or equal to the specified
|
||
|
|
offset.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="TFile.Reader.Scanner" type="org.apache.hadoop.io.file.tfile.TFile.Reader, org.apache.hadoop.io.file.tfile.RawComparable, org.apache.hadoop.io.file.tfile.RawComparable"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
|
||
|
|
@param reader
|
||
|
|
The TFile reader object.
|
||
|
|
@param beginKey
|
||
|
|
Begin key of the scan. If null, scan from the first <K,V>
|
||
|
|
entry of the TFile.
|
||
|
|
@param endKey
|
||
|
|
End key of the scan. If null, scan up to the last <K, V> entry
|
||
|
|
of the TFile.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="seekTo" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is greater than or equal
|
||
|
|
to the input key. Synonymous to seekTo(key, 0, key.length). The entry
|
||
|
|
returned by the previous entry() call will be invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@return true if we find an equal key.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="seekTo" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<param name="keyOffset" type="int"/>
|
||
|
|
<param name="keyLen" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is greater than or equal
|
||
|
|
to the input key. The entry returned by the previous entry() call will
|
||
|
|
be invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@param keyOffset
|
||
|
|
offset in the key buffer.
|
||
|
|
@param keyLen
|
||
|
|
key buffer length.
|
||
|
|
@return true if we find an equal key; false otherwise.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="rewind"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Rewind to the first entry in the scanner. The entry returned by the
|
||
|
|
previous entry() call will be invalid.
|
||
|
|
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="seekToEnd"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Seek to the end of the scanner. The entry returned by the previous
|
||
|
|
entry() call will be invalid.
|
||
|
|
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="lowerBound"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is greater than or equal
|
||
|
|
to the input key. Synonymous to lowerBound(key, 0, key.length). The
|
||
|
|
entry returned by the previous entry() call will be invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="lowerBound"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<param name="keyOffset" type="int"/>
|
||
|
|
<param name="keyLen" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is greater than or equal
|
||
|
|
to the input key. The entry returned by the previous entry() call will
|
||
|
|
be invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@param keyOffset
|
||
|
|
offset in the key buffer.
|
||
|
|
@param keyLen
|
||
|
|
key buffer length.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="upperBound"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is strictly greater than
|
||
|
|
the input key. Synonymous to upperBound(key, 0, key.length). The entry
|
||
|
|
returned by the previous entry() call will be invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="upperBound"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<param name="keyOffset" type="int"/>
|
||
|
|
<param name="keyLen" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Move the cursor to the first entry whose key is strictly greater than
|
||
|
|
the input key. The entry returned by the previous entry() call will be
|
||
|
|
invalid.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
The input key
|
||
|
|
@param keyOffset
|
||
|
|
offset in the key buffer.
|
||
|
|
@param keyLen
|
||
|
|
key buffer length.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="advance" 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[Move the cursor to the next key-value pair. The entry returned by the
|
||
|
|
previous entry() call will be invalid.
|
||
|
|
|
||
|
|
@return true if the cursor successfully moves. False when cursor is
|
||
|
|
already at the end location and cannot be advanced.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="close"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Close the scanner. Release all resources. The behavior of using the
|
||
|
|
scanner after calling close is not defined. The entry returned by the
|
||
|
|
previous entry() call will be invalid.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="atEnd" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Is cursor at the end location?
|
||
|
|
|
||
|
|
@return true if the cursor is at the end location.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="entry" return="org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry"
|
||
|
|
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 an entry to access the key and value.
|
||
|
|
|
||
|
|
@return The Entry object to access the key and value.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getRecordNum" 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[Get the RecordNum corresponding to the entry pointed by the cursor.
|
||
|
|
@return The RecordNum corresponding to the entry pointed by the cursor.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The TFile Scanner. The Scanner has an implicit cursor, which, upon
|
||
|
|
creation, points to the first key-value pair in the scan range. If the
|
||
|
|
scan range is empty, the cursor will point to the end of the scan range.
|
||
|
|
<p>
|
||
|
|
Use {@link Scanner#atEnd()} to test whether the cursor is at the end
|
||
|
|
location of the scanner.
|
||
|
|
<p>
|
||
|
|
Use {@link Scanner#advance()} to move the cursor to the next key-value
|
||
|
|
pair (or end if none exists). Use seekTo methods (
|
||
|
|
{@link Scanner#seekTo(byte[])} or
|
||
|
|
{@link Scanner#seekTo(byte[], int, int)}) to seek to any arbitrary
|
||
|
|
location in the covered range (including backward seeking). Use
|
||
|
|
{@link Scanner#rewind()} to seek back to the beginning of the scanner.
|
||
|
|
Use {@link Scanner#seekToEnd()} to seek to the end of the scanner.
|
||
|
|
<p>
|
||
|
|
Actual keys and values may be obtained through {@link Scanner.Entry}
|
||
|
|
object, which is obtained through {@link Scanner#entry()}.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry -->
|
||
|
|
<class name="TFile.Reader.Scanner.Entry" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.Comparable"/>
|
||
|
|
<constructor name="TFile.Reader.Scanner.Entry"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getKeyLength" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the length of the key.
|
||
|
|
|
||
|
|
@return the length of the key.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="get"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.io.BytesWritable"/>
|
||
|
|
<param name="value" type="org.apache.hadoop.io.BytesWritable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the key and value in one shot into BytesWritables. This is
|
||
|
|
equivalent to getKey(key); getValue(value);
|
||
|
|
|
||
|
|
@param key
|
||
|
|
BytesWritable to hold key.
|
||
|
|
@param value
|
||
|
|
BytesWritable to hold value
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKey" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.io.BytesWritable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the key into BytesWritable. The input BytesWritable will be
|
||
|
|
automatically resized to the actual key size.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
BytesWritable to hold the key.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValue" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="value" type="org.apache.hadoop.io.BytesWritable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the value into BytesWritable. The input BytesWritable will be
|
||
|
|
automatically resized to the actual value size. The implementation
|
||
|
|
directly uses the buffer inside BytesWritable for storing the value.
|
||
|
|
The call does not require the value length to be known.
|
||
|
|
|
||
|
|
@param value
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeKey" return="int"
|
||
|
|
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[Writing the key to the output stream. This method avoids copying key
|
||
|
|
buffer from Scanner into user buffer, then writing to the output
|
||
|
|
stream.
|
||
|
|
|
||
|
|
@param out
|
||
|
|
The output stream
|
||
|
|
@return the length of the key.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeValue" return="long"
|
||
|
|
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[Writing the value to the output stream. This method avoids copying
|
||
|
|
value data from Scanner into user buffer, then writing to the output
|
||
|
|
stream. It does not require the value length to be known.
|
||
|
|
|
||
|
|
@param out
|
||
|
|
The output stream
|
||
|
|
@return the length of the value
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKey" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the key into user supplied buffer.
|
||
|
|
|
||
|
|
@param buf
|
||
|
|
The buffer supplied by user. The length of the buffer must
|
||
|
|
not be shorter than the key length.
|
||
|
|
@return The length of the key.
|
||
|
|
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKey" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the key into user supplied buffer.
|
||
|
|
|
||
|
|
@param buf
|
||
|
|
The buffer supplied by user.
|
||
|
|
@param offset
|
||
|
|
The starting offset of the user buffer where we should copy
|
||
|
|
the key into. Requiring the key-length + offset no greater
|
||
|
|
than the buffer length.
|
||
|
|
@return The length of the key.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getKeyStream" return="java.io.DataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Streaming access to the key. Useful for desrializing the key into
|
||
|
|
user objects.
|
||
|
|
|
||
|
|
@return The input stream.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValueLength" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the length of the value. isValueLengthKnown() must be tested
|
||
|
|
true.
|
||
|
|
|
||
|
|
@return the length of the value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValue" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy value into user-supplied buffer. User supplied buffer must be
|
||
|
|
large enough to hold the whole value. The value part of the key-value
|
||
|
|
pair pointed by the current cursor is not cached and can only be
|
||
|
|
examined once. Calling any of the following functions more than once
|
||
|
|
without moving the cursor will result in exception:
|
||
|
|
{@link #getValue(byte[])}, {@link #getValue(byte[], int)},
|
||
|
|
{@link #getValueStream}.
|
||
|
|
|
||
|
|
@return the length of the value. Does not require
|
||
|
|
isValueLengthKnown() to be true.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValue" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy value into user-supplied buffer. User supplied buffer must be
|
||
|
|
large enough to hold the whole value (starting from the offset). The
|
||
|
|
value part of the key-value pair pointed by the current cursor is not
|
||
|
|
cached and can only be examined once. Calling any of the following
|
||
|
|
functions more than once without moving the cursor will result in
|
||
|
|
exception: {@link #getValue(byte[])}, {@link #getValue(byte[], int)},
|
||
|
|
{@link #getValueStream}.
|
||
|
|
|
||
|
|
@return the length of the value. Does not require
|
||
|
|
isValueLengthKnown() to be true.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValueStream" return="java.io.DataInputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stream access to value. The value part of the key-value pair pointed
|
||
|
|
by the current cursor is not cached and can only be examined once.
|
||
|
|
Calling any of the following functions more than once without moving
|
||
|
|
the cursor will result in exception: {@link #getValue(byte[])},
|
||
|
|
{@link #getValue(byte[], int)}, {@link #getValueStream}.
|
||
|
|
|
||
|
|
@return The input stream for reading the value.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isValueLengthKnown" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check whether it is safe to call getValueLength().
|
||
|
|
|
||
|
|
@return true if value length is known before hand. Values less than
|
||
|
|
the chunk size will always have their lengths known before
|
||
|
|
hand. Values that are written out as a whole (with advertised
|
||
|
|
length up-front) will always have their lengths known in
|
||
|
|
read.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareTo" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compare the entry key to another key. Synonymous to compareTo(key, 0,
|
||
|
|
key.length).
|
||
|
|
|
||
|
|
@param buf
|
||
|
|
The key buffer.
|
||
|
|
@return comparison result between the entry key with the input key.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareTo" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compare the entry key to another key. Synonymous to compareTo(new
|
||
|
|
ByteArray(buf, offset, length)
|
||
|
|
|
||
|
|
@param buf
|
||
|
|
The key buffer
|
||
|
|
@param offset
|
||
|
|
offset into the key buffer.
|
||
|
|
@param length
|
||
|
|
the length of the key.
|
||
|
|
@return comparison result between the entry key with the input key.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareTo" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.io.file.tfile.RawComparable"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compare an entry with a RawComparable object. This is useful when
|
||
|
|
Entries are stored in a collection, and we want to compare a user
|
||
|
|
supplied key.]]>
|
||
|
|
</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[Compare whether this and other points to the same key value.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Entry to a <Key, Value> pair.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.TFile.Reader.Scanner.Entry -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.TFile.Writer -->
|
||
|
|
<class name="TFile.Writer" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.io.Closeable"/>
|
||
|
|
<constructor name="TFile.Writer" type="org.apache.hadoop.fs.FSDataOutputStream, int, java.lang.String, 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[Constructor
|
||
|
|
|
||
|
|
@param fsdos
|
||
|
|
output stream for writing. Must be at position 0.
|
||
|
|
@param minBlockSize
|
||
|
|
Minimum compressed block size in bytes. A compression block will
|
||
|
|
not be closed until it reaches this size except for the last
|
||
|
|
block.
|
||
|
|
@param compressName
|
||
|
|
Name of the compression algorithm. Must be one of the strings
|
||
|
|
returned by {@link TFile#getSupportedCompressionAlgorithms()}.
|
||
|
|
@param comparator
|
||
|
|
Leave comparator as null or empty string if TFile is not sorted.
|
||
|
|
Otherwise, provide the string name for the comparison algorithm
|
||
|
|
for keys. Two kinds of comparators are supported.
|
||
|
|
<ul>
|
||
|
|
<li>Algorithmic comparator: binary comparators that is language
|
||
|
|
independent. Currently, only "memcmp" is supported.
|
||
|
|
<li>Language-specific comparator: binary comparators that can
|
||
|
|
only be constructed in specific language. For Java, the syntax
|
||
|
|
is "jclass:", followed by the class name of the RawComparator.
|
||
|
|
Currently, we only support RawComparators that can be
|
||
|
|
constructed through the default constructor (with no
|
||
|
|
parameters). Parameterized RawComparators such as
|
||
|
|
{@link WritableComparator} or
|
||
|
|
{@link JavaSerializationComparator} may not be directly used.
|
||
|
|
One should write a wrapper class that inherits from such classes
|
||
|
|
and use its default constructor to perform proper
|
||
|
|
initialization.
|
||
|
|
</ul>
|
||
|
|
@param conf
|
||
|
|
The configuration object.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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[Close the Writer. Resources will be released regardless of the exceptions
|
||
|
|
being thrown. Future close calls will have no effect.
|
||
|
|
|
||
|
|
The underlying FSDataOutputStream is not closed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<param name="value" type="byte[]"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adding a new key-value pair to the TFile. This is synonymous to
|
||
|
|
append(key, 0, key.length, value, 0, value.length)
|
||
|
|
|
||
|
|
@param key
|
||
|
|
Buffer for key.
|
||
|
|
@param value
|
||
|
|
Buffer for value.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="byte[]"/>
|
||
|
|
<param name="koff" type="int"/>
|
||
|
|
<param name="klen" type="int"/>
|
||
|
|
<param name="value" type="byte[]"/>
|
||
|
|
<param name="voff" type="int"/>
|
||
|
|
<param name="vlen" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adding a new key-value pair to TFile.
|
||
|
|
|
||
|
|
@param key
|
||
|
|
buffer for key.
|
||
|
|
@param koff
|
||
|
|
offset in key buffer.
|
||
|
|
@param klen
|
||
|
|
length of key.
|
||
|
|
@param value
|
||
|
|
buffer for value.
|
||
|
|
@param voff
|
||
|
|
offset in value buffer.
|
||
|
|
@param vlen
|
||
|
|
length of value.
|
||
|
|
@throws IOException
|
||
|
|
Upon IO errors.
|
||
|
|
<p>
|
||
|
|
If an exception is thrown, the TFile will be in an inconsistent
|
||
|
|
state. The only legitimate call after that would be close]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="prepareAppendKey" return="java.io.DataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Obtain an output stream for writing a key into TFile. This may only be
|
||
|
|
called when there is no active Key appending stream or value appending
|
||
|
|
stream.
|
||
|
|
|
||
|
|
@param length
|
||
|
|
The expected length of the key. If length of the key is not
|
||
|
|
known, set length = -1. Otherwise, the application must write
|
||
|
|
exactly as many bytes as specified here before calling close on
|
||
|
|
the returned output stream.
|
||
|
|
@return The key appending output stream.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="prepareAppendValue" return="java.io.DataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Obtain an output stream for writing a value into TFile. This may only be
|
||
|
|
called right after a key appending operation (the key append stream must
|
||
|
|
be closed).
|
||
|
|
|
||
|
|
@param length
|
||
|
|
The expected length of the value. If length of the value is not
|
||
|
|
known, set length = -1. Otherwise, the application must write
|
||
|
|
exactly as many bytes as specified here before calling close on
|
||
|
|
the returned output stream. Advertising the value size up-front
|
||
|
|
guarantees that the value is encoded in one chunk, and avoids
|
||
|
|
intermediate chunk buffering.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="prepareMetaBlock" return="java.io.DataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<param name="compressName" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="MetaBlockAlreadyExists" type="org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Obtain an output stream for creating a meta block. This function may not
|
||
|
|
be called when there is a key append stream or value append stream
|
||
|
|
active. No more key-value insertion is allowed after a meta data block
|
||
|
|
has been added to TFile.
|
||
|
|
|
||
|
|
@param name
|
||
|
|
Name of the meta block.
|
||
|
|
@param compressName
|
||
|
|
Name of the compression algorithm to be used. Must be one of the
|
||
|
|
strings returned by
|
||
|
|
{@link TFile#getSupportedCompressionAlgorithms()}.
|
||
|
|
@return A DataOutputStream that can be used to write Meta Block data.
|
||
|
|
Closing the stream would signal the ending of the block.
|
||
|
|
@throws IOException
|
||
|
|
@throws MetaBlockAlreadyExists
|
||
|
|
the Meta Block with the same name already exists.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="prepareMetaBlock" return="java.io.DataOutputStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="MetaBlockAlreadyExists" type="org.apache.hadoop.io.file.tfile.MetaBlockAlreadyExists"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Obtain an output stream for creating a meta block. This function may not
|
||
|
|
be called when there is a key append stream or value append stream
|
||
|
|
active. No more key-value insertion is allowed after a meta data block
|
||
|
|
has been added to TFile. Data will be compressed using the default
|
||
|
|
compressor as defined in Writer's constructor.
|
||
|
|
|
||
|
|
@param name
|
||
|
|
Name of the meta block.
|
||
|
|
@return A DataOutputStream that can be used to write Meta Block data.
|
||
|
|
Closing the stream would signal the ending of the block.
|
||
|
|
@throws IOException
|
||
|
|
@throws MetaBlockAlreadyExists
|
||
|
|
the Meta Block with the same name already exists.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[TFile Writer.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.TFile.Writer -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.Utils -->
|
||
|
|
<class name="Utils" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="writeVInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="n" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Encoding an integer into a variable-length encoding format. Synonymous to
|
||
|
|
<code>Utils#writeVLong(out, n)</code>.
|
||
|
|
|
||
|
|
@param out
|
||
|
|
output stream
|
||
|
|
@param n
|
||
|
|
The integer to be encoded
|
||
|
|
@throws IOException
|
||
|
|
@see Utils#writeVLong(DataOutput, long)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeVLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="n" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Encoding a Long integer into a variable-length encoding format.
|
||
|
|
<ul>
|
||
|
|
<li>if n in [-32, 127): encode in one byte with the actual value.
|
||
|
|
Otherwise,
|
||
|
|
<li>if n in [-20*2^8, 20*2^8): encode in two bytes: byte[0] = n/256 - 52;
|
||
|
|
byte[1]=n&0xff. Otherwise,
|
||
|
|
<li>if n IN [-16*2^16, 16*2^16): encode in three bytes: byte[0]=n/2^16 -
|
||
|
|
88; byte[1]=(n>>8)&0xff; byte[2]=n&0xff. Otherwise,
|
||
|
|
<li>if n in [-8*2^24, 8*2^24): encode in four bytes: byte[0]=n/2^24 - 112;
|
||
|
|
byte[1] = (n>>16)&0xff; byte[2] = (n>>8)&0xff; byte[3]=n&0xff. Otherwise:
|
||
|
|
<li>if n in [-2^31, 2^31): encode in five bytes: byte[0]=-125; byte[1] =
|
||
|
|
(n>>24)&0xff; byte[2]=(n>>16)&0xff; byte[3]=(n>>8)&0xff; byte[4]=n&0xff;
|
||
|
|
<li>if n in [-2^39, 2^39): encode in six bytes: byte[0]=-124; byte[1] =
|
||
|
|
(n>>32)&0xff; byte[2]=(n>>24)&0xff; byte[3]=(n>>16)&0xff;
|
||
|
|
byte[4]=(n>>8)&0xff; byte[5]=n&0xff
|
||
|
|
<li>if n in [-2^47, 2^47): encode in seven bytes: byte[0]=-123; byte[1] =
|
||
|
|
(n>>40)&0xff; byte[2]=(n>>32)&0xff; byte[3]=(n>>24)&0xff;
|
||
|
|
byte[4]=(n>>16)&0xff; byte[5]=(n>>8)&0xff; byte[6]=n&0xff;
|
||
|
|
<li>if n in [-2^55, 2^55): encode in eight bytes: byte[0]=-122; byte[1] =
|
||
|
|
(n>>48)&0xff; byte[2] = (n>>40)&0xff; byte[3]=(n>>32)&0xff;
|
||
|
|
byte[4]=(n>>24)&0xff; byte[5]=(n>>16)&0xff; byte[6]=(n>>8)&0xff;
|
||
|
|
byte[7]=n&0xff;
|
||
|
|
<li>if n in [-2^63, 2^63): encode in nine bytes: byte[0]=-121; byte[1] =
|
||
|
|
(n>>54)&0xff; byte[2] = (n>>48)&0xff; byte[3] = (n>>40)&0xff;
|
||
|
|
byte[4]=(n>>32)&0xff; byte[5]=(n>>24)&0xff; byte[6]=(n>>16)&0xff;
|
||
|
|
byte[7]=(n>>8)&0xff; byte[8]=n&0xff;
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
@param out
|
||
|
|
output stream
|
||
|
|
@param n
|
||
|
|
the integer number
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVInt" return="int"
|
||
|
|
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[Decoding the variable-length integer. Synonymous to
|
||
|
|
<code>(int)Utils#readVLong(in)</code>.
|
||
|
|
|
||
|
|
@param in
|
||
|
|
input stream
|
||
|
|
@return the decoded integer
|
||
|
|
@throws IOException
|
||
|
|
|
||
|
|
@see Utils#readVLong(DataInput)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVLong" return="long"
|
||
|
|
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[Decoding the variable-length integer. Suppose the value of the first byte
|
||
|
|
is FB, and the following bytes are NB[*].
|
||
|
|
<ul>
|
||
|
|
<li>if (FB >= -32), return (long)FB;
|
||
|
|
<li>if (FB in [-72, -33]), return (FB+52)<<8 + NB[0]&0xff;
|
||
|
|
<li>if (FB in [-104, -73]), return (FB+88)<<16 + (NB[0]&0xff)<<8 +
|
||
|
|
NB[1]&0xff;
|
||
|
|
<li>if (FB in [-120, -105]), return (FB+112)<<24 + (NB[0]&0xff)<<16 +
|
||
|
|
(NB[1]&0xff)<<8 + NB[2]&0xff;
|
||
|
|
<li>if (FB in [-128, -121]), return interpret NB[FB+129] as a signed
|
||
|
|
big-endian integer.
|
||
|
|
|
||
|
|
@param in
|
||
|
|
input stream
|
||
|
|
@return the decoded long integer.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a String as a VInt n, followed by n Bytes as in Text format.
|
||
|
|
|
||
|
|
@param out
|
||
|
|
@param s
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
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[Read a String as a VInt n, followed by n Bytes in Text format.
|
||
|
|
|
||
|
|
@param in
|
||
|
|
The input stream.
|
||
|
|
@return The string
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="lowerBound" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="list" type="java.util.List"/>
|
||
|
|
<param name="key" type="T"/>
|
||
|
|
<param name="cmp" type="java.util.Comparator"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Lower bound binary search. Find the index to the first element in the list
|
||
|
|
that compares greater than or equal to key.
|
||
|
|
|
||
|
|
@param <T>
|
||
|
|
Type of the input key.
|
||
|
|
@param list
|
||
|
|
The list
|
||
|
|
@param key
|
||
|
|
The input key.
|
||
|
|
@param cmp
|
||
|
|
Comparator for the key.
|
||
|
|
@return The index to the desired element if it exists; or list.size()
|
||
|
|
otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="upperBound" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="list" type="java.util.List"/>
|
||
|
|
<param name="key" type="T"/>
|
||
|
|
<param name="cmp" type="java.util.Comparator"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Upper bound binary search. Find the index to the first element in the list
|
||
|
|
that compares greater than the input key.
|
||
|
|
|
||
|
|
@param <T>
|
||
|
|
Type of the input key.
|
||
|
|
@param list
|
||
|
|
The list
|
||
|
|
@param key
|
||
|
|
The input key.
|
||
|
|
@param cmp
|
||
|
|
Comparator for the key.
|
||
|
|
@return The index to the desired element if it exists; or list.size()
|
||
|
|
otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="lowerBound" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="list" type="java.util.List"/>
|
||
|
|
<param name="key" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Lower bound binary search. Find the index to the first element in the list
|
||
|
|
that compares greater than or equal to key.
|
||
|
|
|
||
|
|
@param <T>
|
||
|
|
Type of the input key.
|
||
|
|
@param list
|
||
|
|
The list
|
||
|
|
@param key
|
||
|
|
The input key.
|
||
|
|
@return The index to the desired element if it exists; or list.size()
|
||
|
|
otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="upperBound" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="list" type="java.util.List"/>
|
||
|
|
<param name="key" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Upper bound binary search. Find the index to the first element in the list
|
||
|
|
that compares greater than the input key.
|
||
|
|
|
||
|
|
@param <T>
|
||
|
|
Type of the input key.
|
||
|
|
@param list
|
||
|
|
The list
|
||
|
|
@param key
|
||
|
|
The input key.
|
||
|
|
@return The index to the desired element if it exists; or list.size()
|
||
|
|
otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Supporting Utility classes used by TFile, and shared by users of TFile.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.Utils -->
|
||
|
|
<!-- start class org.apache.hadoop.io.file.tfile.Utils.Version -->
|
||
|
|
<class name="Utils.Version" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="java.lang.Comparable"/>
|
||
|
|
<constructor name="Utils.Version" type="java.io.DataInput"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct the Version object by reading from the input stream.
|
||
|
|
|
||
|
|
@param in
|
||
|
|
input stream
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Utils.Version" type="short, short"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor.
|
||
|
|
|
||
|
|
@param major
|
||
|
|
major version.
|
||
|
|
@param minor
|
||
|
|
minor version.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<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[Write the objec to a DataOutput. The serialized format of the Version is
|
||
|
|
major version followed by minor version, both as big-endian short
|
||
|
|
integers.
|
||
|
|
|
||
|
|
@param out
|
||
|
|
The DataOutput object.
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMajor" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the major version.
|
||
|
|
|
||
|
|
@return Major version.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMinor" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the minor version.
|
||
|
|
|
||
|
|
@return The minor version.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="size" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the size of the serialized Version object.
|
||
|
|
|
||
|
|
@return serialized size of the version object.]]>
|
||
|
|
</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[Return a string representation of the version.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compatibleWith" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="other" type="org.apache.hadoop.io.file.tfile.Utils.Version"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Test compatibility.
|
||
|
|
|
||
|
|
@param other
|
||
|
|
The Version object to test compatibility with.
|
||
|
|
@return true if both versions have the same major version number; false
|
||
|
|
otherwise.]]>
|
||
|
|
</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.file.tfile.Utils.Version"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Compare this version with another version.]]>
|
||
|
|
</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"/>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A generic Version class. We suggest applications built on top of TFile use
|
||
|
|
this class to maintain version information in their meta blocks.
|
||
|
|
|
||
|
|
A version number consists of a major version and a minor version. The
|
||
|
|
suggested usage of major and minor version number is to increment major
|
||
|
|
version number when the new storage format is not backward compatible, and
|
||
|
|
increment the minor version otherwise.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.file.tfile.Utils.Version -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.io.serializer">
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.JavaSerialization -->
|
||
|
|
<class name="JavaSerialization" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.serializer.Serialization"/>
|
||
|
|
<constructor name="JavaSerialization"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="accept" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
An experimental {@link Serialization} for Java {@link Serializable} classes.
|
||
|
|
</p>
|
||
|
|
@see JavaSerializationComparator]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.JavaSerialization -->
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
|
||
|
|
<class name="JavaSerializationComparator" extends="org.apache.hadoop.io.serializer.DeserializerComparator"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="JavaSerializationComparator"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</constructor>
|
||
|
|
<method name="compare" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="o1" type="T"/>
|
||
|
|
<param name="o2" type="T"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
A {@link RawComparator} that uses a {@link JavaSerialization}
|
||
|
|
{@link Deserializer} to deserialize objects that are then compared via
|
||
|
|
their {@link Comparable} interfaces.
|
||
|
|
</p>
|
||
|
|
@param <T>
|
||
|
|
@see JavaSerialization]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.JavaSerializationComparator -->
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.WritableSerialization -->
|
||
|
|
<class name="WritableSerialization" extends="org.apache.hadoop.conf.Configured"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.serializer.Serialization"/>
|
||
|
|
<constructor name="WritableSerialization"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="accept" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A {@link Serialization} for {@link Writable}s that delegates to
|
||
|
|
{@link Writable#write(java.io.DataOutput)} and
|
||
|
|
{@link Writable#readFields(java.io.DataInput)}.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.WritableSerialization -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
This package provides a mechanism for using different serialization frameworks
|
||
|
|
in Hadoop. The property "io.serializations" defines a list of
|
||
|
|
{@link org.apache.hadoop.io.serializer.Serialization}s that know how to create
|
||
|
|
{@link org.apache.hadoop.io.serializer.Serializer}s and
|
||
|
|
{@link org.apache.hadoop.io.serializer.Deserializer}s.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
To add a new serialization framework write an implementation of
|
||
|
|
{@link org.apache.hadoop.io.serializer.Serialization} and add its name to the
|
||
|
|
"io.serializations" property.
|
||
|
|
</p>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.io.serializer.avro">
|
||
|
|
<!-- start interface org.apache.hadoop.io.serializer.avro.AvroReflectSerializable -->
|
||
|
|
<interface name="AvroReflectSerializable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Tag interface for Avro 'reflect' serializable classes. Classes implementing
|
||
|
|
this interface can be serialized/deserialized using
|
||
|
|
{@link AvroReflectSerialization}.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.io.serializer.avro.AvroReflectSerializable -->
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.avro.AvroReflectSerialization -->
|
||
|
|
<class name="AvroReflectSerialization" extends="org.apache.hadoop.io.serializer.avro.AvroSerialization"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="AvroReflectSerialization"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="accept" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getReader" return="org.apache.avro.io.DatumReader"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSchema" return="org.apache.avro.Schema"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="t" type="java.lang.Object"/>
|
||
|
|
</method>
|
||
|
|
<method name="getWriter" return="org.apache.avro.io.DatumWriter"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<field name="AVRO_REFLECT_PACKAGES" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Key to configure packages that contain classes to be serialized and
|
||
|
|
deserialized using this class. Multiple packages can be specified using
|
||
|
|
comma-separated list.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serialization for Avro Reflect classes. For a class to be accepted by this
|
||
|
|
serialization, it must either be in the package list configured via
|
||
|
|
<code>avro.reflect.pkgs</code> or implement
|
||
|
|
{@link AvroReflectSerializable} interface.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.avro.AvroReflectSerialization -->
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.avro.AvroSerialization -->
|
||
|
|
<class name="AvroSerialization" extends="org.apache.hadoop.conf.Configured"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.io.serializer.Serialization"/>
|
||
|
|
<constructor name="AvroSerialization"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getDeserializer" return="org.apache.hadoop.io.serializer.Deserializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSerializer" return="org.apache.hadoop.io.serializer.Serializer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSchema" return="org.apache.avro.Schema"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="t" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return an Avro Schema instance for the given class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getWriter" return="org.apache.avro.io.DatumWriter"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create and return Avro DatumWriter for the given class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getReader" return="org.apache.avro.io.DatumReader"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create and return Avro DatumReader for the given class.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="AVRO_SCHEMA_KEY" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Base class for providing serialization to Avro types.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.avro.AvroSerialization -->
|
||
|
|
<!-- start class org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization -->
|
||
|
|
<class name="AvroSpecificSerialization" extends="org.apache.hadoop.io.serializer.avro.AvroSerialization"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="AvroSpecificSerialization"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="accept" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getReader" return="org.apache.avro.io.DatumReader"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<method name="getSchema" return="org.apache.avro.Schema"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="t" type="org.apache.avro.specific.SpecificRecord"/>
|
||
|
|
</method>
|
||
|
|
<method name="getWriter" return="org.apache.avro.io.DatumWriter"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="clazz" type="java.lang.Class"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serialization for Avro Specific classes. This serialization is to be used
|
||
|
|
for classes generated by Avro's 'specific' compiler.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
This package provides Avro serialization in Hadoop. This can be used to
|
||
|
|
serialize/deserialize Avro types in Hadoop.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Use {@link org.apache.hadoop.io.serializer.avro.AvroSpecificSerialization} for
|
||
|
|
serialization of classes generated by Avro's 'specific' compiler.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Use {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization} for
|
||
|
|
other classes.
|
||
|
|
{@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization} work for
|
||
|
|
any class which is either in the package list configured via
|
||
|
|
{@link org.apache.hadoop.io.serializer.avro.AvroReflectSerialization#AVRO_REFLECT_PACKAGES}
|
||
|
|
or implement {@link org.apache.hadoop.io.serializer.avro.AvroReflectSerializable}
|
||
|
|
interface.
|
||
|
|
</p>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.log">
|
||
|
|
<!-- start class org.apache.hadoop.log.LogLevel -->
|
||
|
|
<class name="LogLevel" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="LogLevel"
|
||
|
|
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[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A command line implementation]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="USAGES" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Change log level in runtime.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.log.LogLevel -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.metrics">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This package defines an API for reporting performance metric information.
|
||
|
|
<p/>
|
||
|
|
The API is abstract so that it can be implemented on top of
|
||
|
|
a variety of metrics client libraries. The choice of
|
||
|
|
client library is a configuration option, and different
|
||
|
|
modules within the same application can use
|
||
|
|
different metrics implementation libraries.
|
||
|
|
<p/>
|
||
|
|
Sub-packages:
|
||
|
|
<dl>
|
||
|
|
<dt><code>org.apache.hadoop.metrics.spi</code></dt>
|
||
|
|
<dd>The abstract Server Provider Interface package. Those wishing to
|
||
|
|
integrate the metrics API with a particular metrics client library should
|
||
|
|
extend this package.</dd>
|
||
|
|
|
||
|
|
<dt><code>org.apache.hadoop.metrics.file</code></dt>
|
||
|
|
<dd>An implementation package which writes the metric data to
|
||
|
|
a file, or sends it to the standard output stream.</dd>
|
||
|
|
|
||
|
|
<dt> <code>org.apache.hadoop.metrics.ganglia</code></dt>
|
||
|
|
<dd>An implementation package which sends metric data to
|
||
|
|
<a href="http://ganglia.sourceforge.net/">Ganglia</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<h3>Introduction to the Metrics API</h3>
|
||
|
|
|
||
|
|
Here is a simple example of how to use this package to report a single
|
||
|
|
metric value:
|
||
|
|
<pre>
|
||
|
|
private ContextFactory contextFactory = ContextFactory.getFactory();
|
||
|
|
|
||
|
|
void reportMyMetric(float myMetric) {
|
||
|
|
MetricsContext myContext = contextFactory.getContext("myContext");
|
||
|
|
MetricsRecord myRecord = myContext.getRecord("myRecord");
|
||
|
|
myRecord.setMetric("myMetric", myMetric);
|
||
|
|
myRecord.update();
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
In this example there are three names:
|
||
|
|
<dl>
|
||
|
|
<dt><i>myContext</i></dt>
|
||
|
|
<dd>The context name will typically identify either the application, or else a
|
||
|
|
module within an application or library.</dd>
|
||
|
|
|
||
|
|
<dt><i>myRecord</i></dt>
|
||
|
|
<dd>The record name generally identifies some entity for which a set of
|
||
|
|
metrics are to be reported. For example, you could have a record named
|
||
|
|
"cacheStats" for reporting a number of statistics relating to the usage of
|
||
|
|
some cache in your application.</dd>
|
||
|
|
|
||
|
|
<dt><i>myMetric</i></dt>
|
||
|
|
<dd>This identifies a particular metric. For example, you might have metrics
|
||
|
|
named "cache_hits" and "cache_misses".
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<h3>Tags</h3>
|
||
|
|
|
||
|
|
In some cases it is useful to have multiple records with the same name. For
|
||
|
|
example, suppose that you want to report statistics about each disk on a computer.
|
||
|
|
In this case, the record name would be something like "diskStats", but you also
|
||
|
|
need to identify the disk which is done by adding a <i>tag</i> to the record.
|
||
|
|
The code could look something like this:
|
||
|
|
<pre>
|
||
|
|
private MetricsRecord diskStats =
|
||
|
|
contextFactory.getContext("myContext").getRecord("diskStats");
|
||
|
|
|
||
|
|
void reportDiskMetrics(String diskName, float diskBusy, float diskUsed) {
|
||
|
|
diskStats.setTag("diskName", diskName);
|
||
|
|
diskStats.setMetric("diskBusy", diskBusy);
|
||
|
|
diskStats.setMetric("diskUsed", diskUsed);
|
||
|
|
diskStats.update();
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<h3>Buffering and Callbacks</h3>
|
||
|
|
|
||
|
|
Data is not sent immediately to the metrics system when
|
||
|
|
<code>MetricsRecord.update()</code> is called. Instead it is stored in an
|
||
|
|
internal table, and the contents of the table are sent periodically.
|
||
|
|
This can be important for two reasons:
|
||
|
|
<ol>
|
||
|
|
<li>It means that a programmer is free to put calls to this API in an
|
||
|
|
inner loop, since updates can be very frequent without slowing down
|
||
|
|
the application significantly.</li>
|
||
|
|
<li>Some implementations can gain efficiency by combining many metrics
|
||
|
|
into a single UDP message.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
The API provides a timer-based callback via the
|
||
|
|
<code>registerUpdater()</code> method. The benefit of this
|
||
|
|
versus using <code>java.util.Timer</code> is that the callbacks will be done
|
||
|
|
immediately before sending the data, making the data as current as possible.
|
||
|
|
|
||
|
|
<h3>Configuration</h3>
|
||
|
|
|
||
|
|
It is possible to programmatically examine and modify configuration data
|
||
|
|
before creating a context, like this:
|
||
|
|
<pre>
|
||
|
|
ContextFactory factory = ContextFactory.getFactory();
|
||
|
|
... examine and/or modify factory attributes ...
|
||
|
|
MetricsContext context = factory.getContext("myContext");
|
||
|
|
</pre>
|
||
|
|
The factory attributes can be examined and modified using the following
|
||
|
|
<code>ContextFactory</code>methods:
|
||
|
|
<ul>
|
||
|
|
<li><code>Object getAttribute(String attributeName)</code></li>
|
||
|
|
<li><code>String[] getAttributeNames()</code></li>
|
||
|
|
<li><code>void setAttribute(String name, Object value)</code></li>
|
||
|
|
<li><code>void removeAttribute(attributeName)</code></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p/>
|
||
|
|
<code>ContextFactory.getFactory()</code> initializes the factory attributes by
|
||
|
|
reading the properties file <code>hadoop-metrics.properties</code> if it exists
|
||
|
|
on the class path.
|
||
|
|
|
||
|
|
<p/>
|
||
|
|
A factory attribute named:
|
||
|
|
<pre>
|
||
|
|
<i>contextName</i>.class
|
||
|
|
</pre>
|
||
|
|
should have as its value the fully qualified name of the class to be
|
||
|
|
instantiated by a call of the <code>CodeFactory</code> method
|
||
|
|
<code>getContext(<i>contextName</i>)</code>. If this factory attribute is not
|
||
|
|
specified, the default is to instantiate
|
||
|
|
<code>org.apache.hadoop.metrics.file.FileContext</code>.
|
||
|
|
|
||
|
|
<p/>
|
||
|
|
Other factory attributes are specific to a particular implementation of this
|
||
|
|
API and are documented elsewhere. For example, configuration attributes for
|
||
|
|
the file and Ganglia implementations can be found in the javadoc for
|
||
|
|
their respective packages.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.metrics.file">
|
||
|
|
<!-- start class org.apache.hadoop.metrics.file.FileContext -->
|
||
|
|
<class name="FileContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="FileContext"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of FileContext]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
</method>
|
||
|
|
<method name="getFileName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the configured file name, or null.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Starts or restarts monitoring, by opening in append-mode, the
|
||
|
|
file specified by the <code>fileName</code> attribute,
|
||
|
|
if specified. Otherwise the data will be written to standard
|
||
|
|
output.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="stopMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stops monitoring, closing the file.
|
||
|
|
@see #close()]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Emits a metrics record to a file.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="flush"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Flushes the output writer, forcing updates to disk.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="FILE_NAME_PROPERTY" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="PERIOD_PROPERTY" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Metrics context for writing metrics to a file.<p/>
|
||
|
|
|
||
|
|
This class is configured by setting ContextFactory attributes which in turn
|
||
|
|
are usually configured through a properties file. All the attributes are
|
||
|
|
prefixed by the contextName. For example, the properties file might contain:
|
||
|
|
<pre>
|
||
|
|
myContextName.fileName=/tmp/metrics.log
|
||
|
|
myContextName.period=5
|
||
|
|
</pre>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.file.FileContext -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Implementation of the metrics package that writes the metrics to a file.
|
||
|
|
Programmers should not normally need to use this package directly. Instead
|
||
|
|
they should use org.hadoop.metrics.
|
||
|
|
|
||
|
|
<p/>
|
||
|
|
These are the implementation specific factory attributes
|
||
|
|
(See ContextFactory.getFactory()):
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><i>contextName</i>.fileName</dt>
|
||
|
|
<dd>The path of the file to which metrics in context <i>contextName</i>
|
||
|
|
are to be appended. If this attribute is not specified, the metrics
|
||
|
|
are written to standard output by default.</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.period</dt>
|
||
|
|
<dd>The period in seconds on which the metric data is written to the
|
||
|
|
file.</dd>
|
||
|
|
|
||
|
|
</dl>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.metrics.ganglia">
|
||
|
|
<!-- start class org.apache.hadoop.metrics.ganglia.GangliaContext -->
|
||
|
|
<class name="GangliaContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="GangliaContext"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of GangliaContext]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Context for sending metrics to Ganglia.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.ganglia.GangliaContext -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<!--
|
||
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
||
|
|
* or more contributor license agreements. See the NOTICE file
|
||
|
|
* distributed with this work for additional information
|
||
|
|
* regarding copyright ownership. The ASF licenses this file
|
||
|
|
* to you under the Apache License, Version 2.0 (the
|
||
|
|
* "License"); you may not use this file except in compliance
|
||
|
|
* with the License. You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
-->
|
||
|
|
|
||
|
|
Implementation of the metrics package that sends metric data to
|
||
|
|
<a href="http://ganglia.sourceforge.net/">Ganglia</a>.
|
||
|
|
Programmers should not normally need to use this package directly. Instead
|
||
|
|
they should use org.hadoop.metrics.
|
||
|
|
|
||
|
|
<p/>
|
||
|
|
These are the implementation specific factory attributes
|
||
|
|
(See ContextFactory.getFactory()):
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><i>contextName</i>.servers</dt>
|
||
|
|
<dd>Space and/or comma separated sequence of servers to which UDP
|
||
|
|
messages should be sent.</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.period</dt>
|
||
|
|
<dd>The period in seconds on which the metric data is sent to the
|
||
|
|
server(s).</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.units.<i>recordName</i>.<i>metricName</i></dt>
|
||
|
|
<dd>The units for the specified metric in the specified record.</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.slope.<i>recordName</i>.<i>metricName</i></dt>
|
||
|
|
<dd>The slope for the specified metric in the specified record.</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.tmax.<i>recordName</i>.<i>metricName</i></dt>
|
||
|
|
<dd>The tmax for the specified metric in the specified record.</dd>
|
||
|
|
|
||
|
|
<dt><i>contextName</i>.dmax.<i>recordName</i>.<i>metricName</i></dt>
|
||
|
|
<dd>The dmax for the specified metric in the specified record.</dd>
|
||
|
|
|
||
|
|
</dl>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.metrics.spi">
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
|
||
|
|
<class name="AbstractMetricsContext" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.metrics.MetricsContext"/>
|
||
|
|
<constructor name="AbstractMetricsContext"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of AbstractMetricsContext]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Initializes the context.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getAttribute" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="attributeName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Convenience method for subclasses to access factory attributes.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getAttributeTable" return="java.util.Map"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tableName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns an attribute-value map derived from the factory attributes
|
||
|
|
by finding all factory attributes that begin with
|
||
|
|
<i>contextName</i>.<i>tableName</i>. The returned map consists of
|
||
|
|
those attributes with the contextName and tableName stripped off.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getContextName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the context name.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getContextFactory" return="org.apache.hadoop.metrics.ContextFactory"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the factory by which this context was created.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Starts or restarts monitoring, the emitting of metrics records.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="stopMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stops monitoring. This does not free buffered data.
|
||
|
|
@see #close()]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="isMonitoring" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns true if monitoring is currently in progress.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="close"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Stops monitoring and frees buffered data, returning this
|
||
|
|
object to its initial state.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="createRecord" return="org.apache.hadoop.metrics.MetricsRecord"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new AbstractMetricsRecord instance with the given <code>recordName</code>.
|
||
|
|
Throws an exception if the metrics implementation is configured with a fixed
|
||
|
|
set of record names and <code>recordName</code> is not in that set.
|
||
|
|
|
||
|
|
@param recordName the name of the record
|
||
|
|
@throws MetricsException if recordName conflicts with configuration data]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newRecord" return="org.apache.hadoop.metrics.MetricsRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Subclasses should override this if they subclass MetricsRecordImpl.
|
||
|
|
@param recordName the name of the record
|
||
|
|
@return newly created instance of MetricsRecordImpl or subclass]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="registerUpdater"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="updater" type="org.apache.hadoop.metrics.Updater"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Registers a callback to be called at time intervals determined by
|
||
|
|
the configuration.
|
||
|
|
|
||
|
|
@param updater object to be run periodically; it should update
|
||
|
|
some metrics records]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="unregisterUpdater"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="updater" type="org.apache.hadoop.metrics.Updater"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Removes a callback, if it exists.
|
||
|
|
|
||
|
|
@param updater object to be removed from the callback list]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getAllRecords" return="java.util.Map"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Retrieves all the records managed by this MetricsContext.
|
||
|
|
Useful for monitoring systems that are polling-based.
|
||
|
|
@return A non-null collection of all monitoring records.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sends a record to the metrics system.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="flush"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Called each period after all records have been emitted, this method does nothing.
|
||
|
|
Subclasses may override it in order to perform some kind of flush.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="update"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Called by MetricsRecordImpl.update(). Creates or updates a row in
|
||
|
|
the internal table of metric data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="remove"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Called by MetricsRecordImpl.remove(). Removes all matching rows in
|
||
|
|
the internal table of metric data. A row matches if it has the same
|
||
|
|
tag names and values as record, but it may also have additional
|
||
|
|
tags.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getPeriod" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the timer period.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setPeriod"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="period" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the timer period]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="parseAndSetPeriod"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="attributeName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[If a period is set in the attribute passed in, override
|
||
|
|
the default with it.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The main class of the Service Provider Interface. This class should be
|
||
|
|
extended in order to integrate the Metrics API with a specific metrics
|
||
|
|
client library. <p/>
|
||
|
|
|
||
|
|
This class implements the internal table of metric data, and the timer
|
||
|
|
on which data is to be sent to the metrics system. Subclasses must
|
||
|
|
override the abstract <code>emitRecord</code> method in order to transmit
|
||
|
|
the data. <p/>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.AbstractMetricsContext -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.CompositeContext -->
|
||
|
|
<class name="CompositeContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CompositeContext"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
</method>
|
||
|
|
<method name="newRecord" return="org.apache.hadoop.metrics.MetricsRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="flush"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMonitoring"
|
||
|
|
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="stopMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="isMonitoring" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return true if all subcontexts are monitoring.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="close"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="registerUpdater"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="updater" type="org.apache.hadoop.metrics.Updater"/>
|
||
|
|
</method>
|
||
|
|
<method name="unregisterUpdater"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="updater" type="org.apache.hadoop.metrics.Updater"/>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.CompositeContext -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
|
||
|
|
<class name="MetricsRecordImpl" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.metrics.MetricsRecord"/>
|
||
|
|
<constructor name="MetricsRecordImpl" type="java.lang.String, org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of FileRecord]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getRecordName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the record name.
|
||
|
|
|
||
|
|
@return the record name]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<param name="tagValue" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named tag to the specified value.
|
||
|
|
|
||
|
|
@param tagName name of the tag
|
||
|
|
@param tagValue new value of the tag
|
||
|
|
@throws MetricsException if the tagName conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<param name="tagValue" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named tag to the specified value.
|
||
|
|
|
||
|
|
@param tagName name of the tag
|
||
|
|
@param tagValue new value of the tag
|
||
|
|
@throws MetricsException if the tagName conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<param name="tagValue" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named tag to the specified value.
|
||
|
|
|
||
|
|
@param tagName name of the tag
|
||
|
|
@param tagValue new value of the tag
|
||
|
|
@throws MetricsException if the tagName conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<param name="tagValue" type="short"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named tag to the specified value.
|
||
|
|
|
||
|
|
@param tagName name of the tag
|
||
|
|
@param tagValue new value of the tag
|
||
|
|
@throws MetricsException if the tagName conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<param name="tagValue" type="byte"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named tag to the specified value.
|
||
|
|
|
||
|
|
@param tagName name of the tag
|
||
|
|
@param tagValue new value of the tag
|
||
|
|
@throws MetricsException if the tagName conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="removeTag"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tagName" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Removes any tag of the specified name.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named metric to the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue new value of the metric
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named metric to the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue new value of the metric
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="short"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named metric to the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue new value of the metric
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="byte"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named metric to the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue new value of the metric
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="float"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the named metric to the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue new value of the metric
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="incrMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Increments the named metric by the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue incremental value
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="incrMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Increments the named metric by the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue incremental value
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="incrMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="short"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Increments the named metric by the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue incremental value
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="incrMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="byte"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Increments the named metric by the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue incremental value
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="incrMetric"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="metricName" type="java.lang.String"/>
|
||
|
|
<param name="metricValue" type="float"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Increments the named metric by the specified value.
|
||
|
|
|
||
|
|
@param metricName name of the metric
|
||
|
|
@param metricValue incremental value
|
||
|
|
@throws MetricsException if the metricName or the type of the metricValue
|
||
|
|
conflicts with the configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="update"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Updates the table of buffered data which is to be sent periodically.
|
||
|
|
If the tag values match an existing row, that row is updated;
|
||
|
|
otherwise, a new row is added.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="remove"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Removes the row, if it exists, in the buffered data table having tags
|
||
|
|
that equal the tags that have been set on this record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An implementation of MetricsRecord. Keeps a back-pointer to the context
|
||
|
|
from which it was created, and delegates back to it on <code>update</code>
|
||
|
|
and <code>remove()</code>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.MetricsRecordImpl -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.MetricValue -->
|
||
|
|
<class name="MetricValue" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="MetricValue" type="java.lang.Number, boolean"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of MetricValue]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="isIncrement" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="isAbsolute" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getNumber" return="java.lang.Number"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<field name="ABSOLUTE" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="INCREMENT" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A Number that is either an absolute or an incremental amount.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.MetricValue -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
|
||
|
|
<class name="NoEmitMetricsContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="NoEmitMetricsContext"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of emitRecord]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A MetricsContext that does not emit data, but, unlike NullContextWithUpdate,
|
||
|
|
does save it for retrieval with getAllRecords().
|
||
|
|
|
||
|
|
This is useful if you want to support {@link MetricsServlet}, but
|
||
|
|
not emit metrics in any other way.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.NoEmitMetricsContext -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.NullContext -->
|
||
|
|
<class name="NullContext" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="NullContext"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of NullContext]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="startMonitoring"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of startMonitoring]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of emitRecord]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="update"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of update]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="remove"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of remove]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Null metrics context: a metrics context which does nothing. Used as the
|
||
|
|
default context, so that no performance data is emitted if no configuration
|
||
|
|
data is found.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.NullContext -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
|
||
|
|
<class name="NullContextWithUpdateThread" extends="org.apache.hadoop.metrics.spi.AbstractMetricsContext"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="NullContextWithUpdateThread"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of NullContextWithUpdateThread]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="init"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="factory" type="org.apache.hadoop.metrics.ContextFactory"/>
|
||
|
|
</method>
|
||
|
|
<method name="emitRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="contextName" type="java.lang.String"/>
|
||
|
|
<param name="recordName" type="java.lang.String"/>
|
||
|
|
<param name="outRec" type="org.apache.hadoop.metrics.spi.OutputRecord"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of emitRecord]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="update"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of update]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="remove"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="record" type="org.apache.hadoop.metrics.spi.MetricsRecordImpl"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Do-nothing version of remove]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A null context which has a thread calling
|
||
|
|
periodically when monitoring is started. This keeps the data sampled
|
||
|
|
correctly.
|
||
|
|
In all other respects, this is like the NULL context: No data is emitted.
|
||
|
|
This is suitable for Monitoring systems like JMX which reads the metrics
|
||
|
|
when someone reads the data from JMX.
|
||
|
|
|
||
|
|
The default impl of start and stop monitoring:
|
||
|
|
is the AbstractMetricsContext is good enough.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.NullContextWithUpdateThread -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.OutputRecord -->
|
||
|
|
<class name="OutputRecord" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="getTagNames" return="java.util.Set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the set of tag names]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTag" return="java.lang.Object"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a tag object which is can be a String, Integer, Short or Byte.
|
||
|
|
|
||
|
|
@return the tag value, or null if there is no such tag]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMetricNames" return="java.util.Set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the set of metric names.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMetric" return="java.lang.Number"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns the metric object which can be a Float, Integer, Short or Byte.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getTagsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.TagMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a copy of this record's tags.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMetricsCopy" return="org.apache.hadoop.metrics.spi.AbstractMetricsContext.MetricMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a copy of this record's metrics.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents a record of metric data to be sent to a metrics system.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.OutputRecord -->
|
||
|
|
<!-- start class org.apache.hadoop.metrics.spi.Util -->
|
||
|
|
<class name="Util" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="parse" return="java.util.List"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="specs" type="java.lang.String"/>
|
||
|
|
<param name="defaultPort" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parses a space and/or comma separated sequence of server specifications
|
||
|
|
of the form <i>hostname</i> or <i>hostname:port</i>. If
|
||
|
|
the specs string is null, defaults to localhost:defaultPort.
|
||
|
|
|
||
|
|
@return a list of InetSocketAddress objects.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Static utility methods]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.metrics.spi.Util -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The Service Provider Interface for the Metrics API. This package provides
|
||
|
|
an interface allowing a variety of metrics reporting implementations to be
|
||
|
|
plugged in to the Metrics API. Examples of such implementations can be found
|
||
|
|
in the packages <code>org.apache.hadoop.metrics.file</code> and
|
||
|
|
<code>org.apache.hadoop.metrics.ganglia</code>.<p/>
|
||
|
|
|
||
|
|
Plugging in an implementation involves writing a concrete subclass of
|
||
|
|
<code>AbstractMetricsContext</code>. The subclass should get its
|
||
|
|
configuration information using the <code>getAttribute(<i>attributeName</i>)</code>
|
||
|
|
method.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.net">
|
||
|
|
<!-- start class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
|
||
|
|
<class name="CachedDNSToSwitchMapping" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.net.DNSToSwitchMapping"/>
|
||
|
|
<constructor name="CachedDNSToSwitchMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="resolve" return="java.util.List"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="names" type="java.util.List"/>
|
||
|
|
</method>
|
||
|
|
<field name="rawMapping" type="org.apache.hadoop.net.DNSToSwitchMapping"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A cached implementation of DNSToSwitchMapping that takes an
|
||
|
|
raw DNSToSwitchMapping and stores the resolved network location in
|
||
|
|
a cache. The following calls to a resolved network location
|
||
|
|
will get its location from the cache.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.net.CachedDNSToSwitchMapping -->
|
||
|
|
<!-- start interface org.apache.hadoop.net.DNSToSwitchMapping -->
|
||
|
|
<interface name="DNSToSwitchMapping" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="resolve" return="java.util.List"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="names" type="java.util.List"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Resolves a list of DNS-names/IP-addresses and returns back a list of
|
||
|
|
switch information (network paths). One-to-one correspondence must be
|
||
|
|
maintained between the elements in the lists.
|
||
|
|
Consider an element in the argument list - x.y.com. The switch information
|
||
|
|
that is returned must be a network path of the form /foo/rack,
|
||
|
|
where / is the root, and 'foo' is the switch where 'rack' is connected.
|
||
|
|
Note the hostname/ip-address is not part of the returned path.
|
||
|
|
The network topology of the cluster would determine the number of
|
||
|
|
components in the network path.
|
||
|
|
@param names
|
||
|
|
@return list of resolved network paths]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An interface that should be implemented to allow pluggable
|
||
|
|
DNS-name/IP-address to RackID resolvers.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.net.DNSToSwitchMapping -->
|
||
|
|
<!-- start class org.apache.hadoop.net.ScriptBasedMapping -->
|
||
|
|
<class name="ScriptBasedMapping" extends="org.apache.hadoop.net.CachedDNSToSwitchMapping"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.conf.Configurable"/>
|
||
|
|
<constructor name="ScriptBasedMapping"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="ScriptBasedMapping" type="org.apache.hadoop.conf.Configuration"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getConf" return="org.apache.hadoop.conf.Configuration"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</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[This class implements the {@link DNSToSwitchMapping} interface using a
|
||
|
|
script configured via net.topology.script.file.name .]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.net.ScriptBasedMapping -->
|
||
|
|
<!-- start class org.apache.hadoop.net.SocksSocketFactory -->
|
||
|
|
<class name="SocksSocketFactory" extends="javax.net.SocketFactory"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.conf.Configurable"/>
|
||
|
|
<constructor name="SocksSocketFactory"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default empty constructor (for use with the reflection API).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SocksSocketFactory" type="java.net.Proxy"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor with a supplied Proxy
|
||
|
|
|
||
|
|
@param proxy the proxy to use to create sockets]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
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="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="addr" type="java.net.InetAddress"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="addr" type="java.net.InetAddress"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<param name="localHostAddr" type="java.net.InetAddress"/>
|
||
|
|
<param name="localPort" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="host" type="java.lang.String"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="UnknownHostException" type="java.net.UnknownHostException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="host" type="java.lang.String"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<param name="localHostAddr" type="java.net.InetAddress"/>
|
||
|
|
<param name="localPort" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="UnknownHostException" type="java.net.UnknownHostException"/>
|
||
|
|
</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="obj" type="java.lang.Object"/>
|
||
|
|
</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[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.net.SocksSocketFactory -->
|
||
|
|
<!-- start class org.apache.hadoop.net.StandardSocketFactory -->
|
||
|
|
<class name="StandardSocketFactory" extends="javax.net.SocketFactory"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="StandardSocketFactory"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default empty constructor (for use with the reflection API).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
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="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="addr" type="java.net.InetAddress"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="addr" type="java.net.InetAddress"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<param name="localHostAddr" type="java.net.InetAddress"/>
|
||
|
|
<param name="localPort" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="host" type="java.lang.String"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="UnknownHostException" type="java.net.UnknownHostException"/>
|
||
|
|
</method>
|
||
|
|
<method name="createSocket" return="java.net.Socket"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="host" type="java.lang.String"/>
|
||
|
|
<param name="port" type="int"/>
|
||
|
|
<param name="localHostAddr" type="java.net.InetAddress"/>
|
||
|
|
<param name="localPort" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<exception name="UnknownHostException" type="java.net.UnknownHostException"/>
|
||
|
|
</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"/>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Specialized SocketFactory to create sockets with a SOCKS proxy]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.net.StandardSocketFactory -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Network-related classes.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.record">
|
||
|
|
<!-- start class org.apache.hadoop.record.BinaryRecordInput -->
|
||
|
|
<class name="BinaryRecordInput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<constructor name="BinaryRecordInput" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of BinaryRecordInput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BinaryRecordInput" type="java.io.DataInput"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of BinaryRecordInput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="get" return="org.apache.hadoop.record.BinaryRecordInput"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="inp" type="java.io.DataInput"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a thread-local record input for the supplied DataInput.
|
||
|
|
@param inp data input stream
|
||
|
|
@return binary record input corresponding to the supplied DataInput.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readByte" return="byte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBool" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBuffer" return="org.apache.hadoop.record.Buffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.BinaryRecordInput -->
|
||
|
|
<!-- start class org.apache.hadoop.record.BinaryRecordOutput -->
|
||
|
|
<class name="BinaryRecordOutput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<constructor name="BinaryRecordOutput" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of BinaryRecordOutput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BinaryRecordOutput" type="java.io.DataOutput"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of BinaryRecordOutput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="get" return="org.apache.hadoop.record.BinaryRecordOutput"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.DataOutput"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get a thread-local record output for the supplied DataOutput.
|
||
|
|
@param out data output stream
|
||
|
|
@return binary record output corresponding to the supplied DataOutput.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeByte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="byte"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBool"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="boolean"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="l" type="long"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeFloat"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="float"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeDouble"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="d" type="double"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="org.apache.hadoop.record.Buffer"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.BinaryRecordOutput -->
|
||
|
|
<!-- start class org.apache.hadoop.record.Buffer -->
|
||
|
|
<class name="Buffer" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="java.lang.Comparable"/>
|
||
|
|
<implements name="java.lang.Cloneable"/>
|
||
|
|
<constructor name="Buffer"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a zero-count sequence.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Buffer" type="byte[]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a Buffer using the byte array as the initial value.
|
||
|
|
|
||
|
|
@param bytes This array becomes the backing storage for the object.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Buffer" type="byte[], int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a Buffer using the byte range as the initial value.
|
||
|
|
|
||
|
|
@param bytes Copy of this array becomes the backing storage for the object.
|
||
|
|
@param offset offset into byte array
|
||
|
|
@param length length of data]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="set"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Use the specified bytes array as underlying sequence.
|
||
|
|
|
||
|
|
@param bytes byte sequence]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="copy"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Copy the specified byte array to the Buffer. Replaces the current buffer.
|
||
|
|
|
||
|
|
@param bytes byte array to be assigned
|
||
|
|
@param offset offset into byte array
|
||
|
|
@param length length of data]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="get" return="byte[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the data from the Buffer.
|
||
|
|
|
||
|
|
@return The data is only valid between 0 and getCount() - 1.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getCount" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the current count of the buffer.]]>
|
||
|
|
</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 count 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="newCapacity" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Change the capacity of the backing storage.
|
||
|
|
The data is preserved if newCapacity >= getCount().
|
||
|
|
@param newCapacity The new capacity in bytes.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="reset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reset the buffer to 0 size]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="truncate"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Change the capacity of the backing store to be the same as the current
|
||
|
|
count of buffer.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="offset" type="int"/>
|
||
|
|
<param name="length" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Append specified bytes to the buffer.
|
||
|
|
|
||
|
|
@param bytes byte array to be appended
|
||
|
|
@param offset offset into byte array
|
||
|
|
@param length length of data]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="append"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Append specified bytes to the buffer
|
||
|
|
|
||
|
|
@param bytes byte array to be appended]]>
|
||
|
|
</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="other" type="java.lang.Object"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Define the sort order of the Buffer.
|
||
|
|
|
||
|
|
@param other The other buffer
|
||
|
|
@return Positive if this is bigger than other, 0 if they are equal, and
|
||
|
|
negative if this is smaller than other.]]>
|
||
|
|
</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"/>
|
||
|
|
</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="toString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="charsetName" type="java.lang.String"/>
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Convert the byte buffer to a string an specific character encoding
|
||
|
|
|
||
|
|
@param charsetName Valid Java Character Set Name]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="clone" return="java.lang.Object"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="CloneNotSupportedException" type="java.lang.CloneNotSupportedException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A byte sequence that is used as a Java native type for buffer.
|
||
|
|
It is resizable and distinguishes between the count of the seqeunce and
|
||
|
|
the current capacity.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.Buffer -->
|
||
|
|
<!-- start class org.apache.hadoop.record.CsvRecordInput -->
|
||
|
|
<class name="CsvRecordInput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<constructor name="CsvRecordInput" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of CsvRecordInput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="readByte" return="byte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBool" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBuffer" return="org.apache.hadoop.record.Buffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.CsvRecordInput -->
|
||
|
|
<!-- start class org.apache.hadoop.record.CsvRecordOutput -->
|
||
|
|
<class name="CsvRecordOutput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<constructor name="CsvRecordOutput" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of CsvRecordOutput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="writeByte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="byte"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBool"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="boolean"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="l" type="long"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeFloat"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="float"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeDouble"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="d" type="double"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="org.apache.hadoop.record.Buffer"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.CsvRecordOutput -->
|
||
|
|
<!-- start interface org.apache.hadoop.record.Index -->
|
||
|
|
<interface name="Index" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="done" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="incr"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Interface that acts as an iterator for deserializing maps.
|
||
|
|
The deserializer returns an instance that the record uses to
|
||
|
|
read vectors and maps. An example of usage is as follows:
|
||
|
|
|
||
|
|
<code>
|
||
|
|
Index idx = startVector(...);
|
||
|
|
while (!idx.done()) {
|
||
|
|
.... // read element of a vector
|
||
|
|
idx.incr();
|
||
|
|
}
|
||
|
|
</code>
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.record.Index -->
|
||
|
|
<!-- start class org.apache.hadoop.record.Record -->
|
||
|
|
<class name="Record" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.io.WritableComparable"/>
|
||
|
|
<implements name="java.lang.Cloneable"/>
|
||
|
|
<constructor name="Record"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="serialize"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serialize a record with tag (ususally field name)
|
||
|
|
@param rout Record output destination
|
||
|
|
@param tag record tag (Used only in tagged serialization e.g. XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="deserialize"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rin" type="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Deserialize a record with a tag (usually field name)
|
||
|
|
@param rin Record input source
|
||
|
|
@param tag Record tag (Used only in tagged serialization e.g. XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareTo" return="int"
|
||
|
|
abstract="true" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="peer" type="java.lang.Object"/>
|
||
|
|
<exception name="ClassCastException" type="java.lang.ClassCastException"/>
|
||
|
|
</method>
|
||
|
|
<method name="serialize"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serialize a record without a tag
|
||
|
|
@param rout Record output destination]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="deserialize"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rin" type="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Deserialize a record without a tag
|
||
|
|
@param rin Record input source]]>
|
||
|
|
</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="din" type="java.io.DataInput"/>
|
||
|
|
<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>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Abstract class that is extended by generated classes.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.Record -->
|
||
|
|
<!-- start class org.apache.hadoop.record.RecordComparator -->
|
||
|
|
<class name="RecordComparator" extends="org.apache.hadoop.io.WritableComparator"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="RecordComparator" type="java.lang.Class"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Construct a raw {@link Record} comparison implementation.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="compare" return="int"
|
||
|
|
abstract="true" 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>
|
||
|
|
<method name="define"
|
||
|
|
abstract="false" native="false" synchronized="true"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="java.lang.Class"/>
|
||
|
|
<param name="comparator" type="org.apache.hadoop.record.RecordComparator"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Register an optimized comparator for a {@link Record} implementation.
|
||
|
|
|
||
|
|
@param c record classs for which a raw comparator is provided
|
||
|
|
@param comparator Raw comparator instance for class c]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A raw record comparator base class
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.RecordComparator -->
|
||
|
|
<!-- start interface org.apache.hadoop.record.RecordInput -->
|
||
|
|
<interface name="RecordInput" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="readByte" return="byte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a byte from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readBool" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a boolean from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read an integer from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a long integer from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a single-precision float from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a double-precision number from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read a UTF-8 encoded string from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readBuffer" return="org.apache.hadoop.record.Buffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Read byte array from serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return value read from serialized record.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for start of the serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for end of the serialized record.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startVector" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for start of the serialized vector.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return Index that is used to count the number of elements.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for end of the serialized vector.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startMap" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for start of the serialized map.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@return Index that is used to count the number of map entries.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check the mark for end of the serialized map.
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Interface that all the Deserializers have to implement.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.record.RecordInput -->
|
||
|
|
<!-- start interface org.apache.hadoop.record.RecordOutput -->
|
||
|
|
<interface name="RecordOutput" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="writeByte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="byte"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a byte to serialized record.
|
||
|
|
@param b Byte to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeBool"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="boolean"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a boolean to serialized record.
|
||
|
|
@param b Boolean to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write an integer to serialized record.
|
||
|
|
@param i Integer to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="l" type="long"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a long integer to serialized record.
|
||
|
|
@param l Long to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeFloat"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="float"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a single-precision float to serialized record.
|
||
|
|
@param f Float to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeDouble"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="d" type="double"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a double precision floating point number to serialized record.
|
||
|
|
@param d Double to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a unicode string to serialized record.
|
||
|
|
@param s String to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="org.apache.hadoop.record.Buffer"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Write a buffer to serialized record.
|
||
|
|
@param buf Buffer to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the start of a record to be serialized.
|
||
|
|
@param r Record to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the end of a serialized record.
|
||
|
|
@param r Record to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the start of a vector to be serialized.
|
||
|
|
@param v Vector to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the end of a serialized vector.
|
||
|
|
@param v Vector to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="startMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="m" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the start of a map to be serialized.
|
||
|
|
@param m Map to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="m" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Mark the end of a serialized map.
|
||
|
|
@param m Map to be serialized
|
||
|
|
@param tag Used by tagged serialization formats (such as XML)
|
||
|
|
@throws IOException Indicates error in serialization]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Interface that alll the serializers have to implement.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.record.RecordOutput -->
|
||
|
|
<!-- start class org.apache.hadoop.record.Utils -->
|
||
|
|
<class name="Utils" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse a float from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Parse a double from a byte array.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded long from a byte array and returns it.
|
||
|
|
@param bytes byte array with decode long
|
||
|
|
@param start starting index
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized long]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="bytes" type="byte[]"/>
|
||
|
|
<param name="start" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Reads a zero-compressed encoded integer from a byte array and returns it.
|
||
|
|
@param bytes byte array with the encoded integer
|
||
|
|
@param start start index
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized integer]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVLong" return="long"
|
||
|
|
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[Reads a zero-compressed encoded long from a stream and return it.
|
||
|
|
@param in input stream
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized long]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="readVInt" return="int"
|
||
|
|
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[Reads a zero-compressed encoded integer from a stream and returns it.
|
||
|
|
@param in input stream
|
||
|
|
@throws java.io.IOException
|
||
|
|
@return deserialized integer]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getVIntSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the encoded length if an integer is stored in a variable-length format
|
||
|
|
@return the encoded length]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeVLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataOutput"/>
|
||
|
|
<param name="i" type="long"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serializes a long to a binary stream with zero-compressed encoding.
|
||
|
|
For -112 <= i <= 127, only one byte is used with the actual value.
|
||
|
|
For other values of i, the first byte value indicates whether the
|
||
|
|
long is positive or negative, and the number of bytes that follow.
|
||
|
|
If the first byte value v is between -113 and -120, the following long
|
||
|
|
is positive, with number of bytes that follow are -(v+112).
|
||
|
|
If the first byte value v is between -121 and -128, the following long
|
||
|
|
is negative, with number of bytes that follow are -(v+120). Bytes are
|
||
|
|
stored in the high-non-zero-byte-first order.
|
||
|
|
|
||
|
|
@param stream Binary output stream
|
||
|
|
@param i Long to be serialized
|
||
|
|
@throws java.io.IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="writeVInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.DataOutput"/>
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serializes an int to a binary stream with zero-compressed encoding.
|
||
|
|
|
||
|
|
@param stream Binary output stream
|
||
|
|
@param i int to be serialized
|
||
|
|
@throws java.io.IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareBytes" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" 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[Lexicographic order of binary data.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="hexchars" type="char[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Various utility functions for Hadooop record I/O runtime.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.Utils -->
|
||
|
|
<!-- start class org.apache.hadoop.record.XmlRecordInput -->
|
||
|
|
<class name="XmlRecordInput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<constructor name="XmlRecordInput" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of XmlRecordInput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="readByte" return="byte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBool" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readInt" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readLong" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readFloat" return="float"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readDouble" return="double"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readString" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="readBuffer" return="org.apache.hadoop.record.Buffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap" return="org.apache.hadoop.record.Index"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[XML Deserializer.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.XmlRecordInput -->
|
||
|
|
<!-- start class org.apache.hadoop.record.XmlRecordOutput -->
|
||
|
|
<class name="XmlRecordOutput" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<constructor name="XmlRecordOutput" type="java.io.OutputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of XmlRecordOutput]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="writeByte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="byte"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBool"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="b" type="boolean"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeInt"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeLong"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="l" type="long"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeFloat"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="f" type="float"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeDouble"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="d" type="double"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeString"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="writeBuffer"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="buf" type="org.apache.hadoop.record.Buffer"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="r" type="org.apache.hadoop.record.Record"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.ArrayList"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="startMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="endMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="v" type="java.util.TreeMap"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[XML Serializer.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.XmlRecordOutput -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
(DEPRECATED) Hadoop record I/O contains classes and a record description language
|
||
|
|
translator for simplifying serialization and deserialization of records in a
|
||
|
|
language-neutral manner.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h2>Introduction</h2>
|
||
|
|
|
||
|
|
Software systems of any significant complexity require mechanisms for data
|
||
|
|
interchange with the outside world. These interchanges typically involve the
|
||
|
|
marshaling and unmarshaling of logical units of data to and from data streams
|
||
|
|
(files, network connections, memory buffers etc.). Applications usually have
|
||
|
|
some code for serializing and deserializing the data types that they manipulate
|
||
|
|
embedded in them. The work of serialization has several features that make
|
||
|
|
automatic code generation for it worthwhile. Given a particular output encoding
|
||
|
|
(binary, XML, etc.), serialization of primitive types and simple compositions
|
||
|
|
of primitives (structs, vectors etc.) is a very mechanical task. Manually
|
||
|
|
written serialization code can be susceptible to bugs especially when records
|
||
|
|
have a large number of fields or a record definition changes between software
|
||
|
|
versions. Lastly, it can be very useful for applications written in different
|
||
|
|
programming languages to be able to share and interchange data. This can be
|
||
|
|
made a lot easier by describing the data records manipulated by these
|
||
|
|
applications in a language agnostic manner and using the descriptions to derive
|
||
|
|
implementations of serialization in multiple target languages.
|
||
|
|
|
||
|
|
This document describes Hadoop Record I/O, a mechanism that is aimed
|
||
|
|
at
|
||
|
|
<ul>
|
||
|
|
<li> enabling the specification of simple serializable data types (records)
|
||
|
|
<li> enabling the generation of code in multiple target languages for
|
||
|
|
marshaling and unmarshaling such types
|
||
|
|
<li> providing target language specific support that will enable application
|
||
|
|
programmers to incorporate generated code into their applications
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
The goals of Hadoop Record I/O are similar to those of mechanisms such as XDR,
|
||
|
|
ASN.1, PADS and ICE. While these systems all include a DDL that enables
|
||
|
|
the specification of most record types, they differ widely in what else they
|
||
|
|
focus on. The focus in Hadoop Record I/O is on data marshaling and
|
||
|
|
multi-lingual support. We take a translator-based approach to serialization.
|
||
|
|
Hadoop users have to describe their data in a simple data description
|
||
|
|
language. The Hadoop DDL translator rcc generates code that users
|
||
|
|
can invoke in order to read/write their data from/to simple stream
|
||
|
|
abstractions. Next we list explicitly some of the goals and non-goals of
|
||
|
|
Hadoop Record I/O.
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Goals</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> Support for commonly used primitive types. Hadoop should include as
|
||
|
|
primitives commonly used builtin types from programming languages we intend to
|
||
|
|
support.
|
||
|
|
|
||
|
|
<li> Support for common data compositions (including recursive compositions).
|
||
|
|
Hadoop should support widely used composite types such as structs and
|
||
|
|
vectors.
|
||
|
|
|
||
|
|
<li> Code generation in multiple target languages. Hadoop should be capable of
|
||
|
|
generating serialization code in multiple target languages and should be
|
||
|
|
easily extensible to new target languages. The initial target languages are
|
||
|
|
C++ and Java.
|
||
|
|
|
||
|
|
<li> Support for generated target languages. Hadooop should include support
|
||
|
|
in the form of headers, libraries, packages for supported target languages
|
||
|
|
that enable easy inclusion and use of generated code in applications.
|
||
|
|
|
||
|
|
<li> Support for multiple output encodings. Candidates include
|
||
|
|
packed binary, comma-separated text, XML etc.
|
||
|
|
|
||
|
|
<li> Support for specifying record types in a backwards/forwards compatible
|
||
|
|
manner. This will probably be in the form of support for optional fields in
|
||
|
|
records. This version of the document does not include a description of the
|
||
|
|
planned mechanism, we intend to include it in the next iteration.
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Non-Goals</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> Serializing existing arbitrary C++ classes.
|
||
|
|
<li> Serializing complex data structures such as trees, linked lists etc.
|
||
|
|
<li> Built-in indexing schemes, compression, or check-sums.
|
||
|
|
<li> Dynamic construction of objects from an XML schema.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
The remainder of this document describes the features of Hadoop record I/O
|
||
|
|
in more detail. Section 2 describes the data types supported by the system.
|
||
|
|
Section 3 lays out the DDL syntax with some examples of simple records.
|
||
|
|
Section 4 describes the process of code generation with rcc. Section 5
|
||
|
|
describes target language mappings and support for Hadoop types. We include a
|
||
|
|
fairly complete description of C++ mappings with intent to include Java and
|
||
|
|
others in upcoming iterations of this document. The last section talks about
|
||
|
|
supported output encodings.
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Data Types and Streams</h2>
|
||
|
|
|
||
|
|
This section describes the primitive and composite types supported by Hadoop.
|
||
|
|
We aim to support a set of types that can be used to simply and efficiently
|
||
|
|
express a wide range of record types in different programming languages.
|
||
|
|
|
||
|
|
<h3>Primitive Types</h3>
|
||
|
|
|
||
|
|
For the most part, the primitive types of Hadoop map directly to primitive
|
||
|
|
types in high level programming languages. Special cases are the
|
||
|
|
ustring (a Unicode string) and buffer types, which we believe
|
||
|
|
find wide use and which are usually implemented in library code and not
|
||
|
|
available as language built-ins. Hadoop also supplies these via library code
|
||
|
|
when a target language built-in is not present and there is no widely
|
||
|
|
adopted "standard" implementation. The complete list of primitive types is:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> byte: An 8-bit unsigned integer.
|
||
|
|
<li> boolean: A boolean value.
|
||
|
|
<li> int: A 32-bit signed integer.
|
||
|
|
<li> long: A 64-bit signed integer.
|
||
|
|
<li> float: A single precision floating point number as described by
|
||
|
|
IEEE-754.
|
||
|
|
<li> double: A double precision floating point number as described by
|
||
|
|
IEEE-754.
|
||
|
|
<li> ustring: A string consisting of Unicode characters.
|
||
|
|
<li> buffer: An arbitrary sequence of bytes.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Composite Types</h3>
|
||
|
|
Hadoop supports a small set of composite types that enable the description
|
||
|
|
of simple aggregate types and containers. A composite type is serialized
|
||
|
|
by sequentially serializing it constituent elements. The supported
|
||
|
|
composite types are:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li> record: An aggregate type like a C-struct. This is a list of
|
||
|
|
typed fields that are together considered a single unit of data. A record
|
||
|
|
is serialized by sequentially serializing its constituent fields. In addition
|
||
|
|
to serialization a record has comparison operations (equality and less-than)
|
||
|
|
implemented for it, these are defined as memberwise comparisons.
|
||
|
|
|
||
|
|
<li>vector: A sequence of entries of the same data type, primitive
|
||
|
|
or composite.
|
||
|
|
|
||
|
|
<li> map: An associative container mapping instances of a key type to
|
||
|
|
instances of a value type. The key and value types may themselves be primitive
|
||
|
|
or composite types.
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Streams</h3>
|
||
|
|
|
||
|
|
Hadoop generates code for serializing and deserializing record types to
|
||
|
|
abstract streams. For each target language Hadoop defines very simple input
|
||
|
|
and output stream interfaces. Application writers can usually develop
|
||
|
|
concrete implementations of these by putting a one method wrapper around
|
||
|
|
an existing stream implementation.
|
||
|
|
|
||
|
|
|
||
|
|
<h2>DDL Syntax and Examples</h2>
|
||
|
|
|
||
|
|
We now describe the syntax of the Hadoop data description language. This is
|
||
|
|
followed by a few examples of DDL usage.
|
||
|
|
|
||
|
|
<h3>Hadoop DDL Syntax</h3>
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
recfile = *include module *record
|
||
|
|
include = "include" path
|
||
|
|
path = (relative-path / absolute-path)
|
||
|
|
module = "module" module-name
|
||
|
|
module-name = name *("." name)
|
||
|
|
record := "class" name "{" 1*(field) "}"
|
||
|
|
field := type name ";"
|
||
|
|
name := ALPHA (ALPHA / DIGIT / "_" )*
|
||
|
|
type := (ptype / ctype)
|
||
|
|
ptype := ("byte" / "boolean" / "int" |
|
||
|
|
"long" / "float" / "double"
|
||
|
|
"ustring" / "buffer")
|
||
|
|
ctype := (("vector" "<" type ">") /
|
||
|
|
("map" "<" type "," type ">" ) ) / name)
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
A DDL file describes one or more record types. It begins with zero or
|
||
|
|
more include declarations, a single mandatory module declaration
|
||
|
|
followed by zero or more class declarations. The semantics of each of
|
||
|
|
these declarations are described below:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li>include: An include declaration specifies a DDL file to be
|
||
|
|
referenced when generating code for types in the current DDL file. Record types
|
||
|
|
in the current compilation unit may refer to types in all included files.
|
||
|
|
File inclusion is recursive. An include does not trigger code
|
||
|
|
generation for the referenced file.
|
||
|
|
|
||
|
|
<li> module: Every Hadoop DDL file must have a single module
|
||
|
|
declaration that follows the list of includes and precedes all record
|
||
|
|
declarations. A module declaration identifies a scope within which
|
||
|
|
the names of all types in the current file are visible. Module names are
|
||
|
|
mapped to C++ namespaces, Java packages etc. in generated code.
|
||
|
|
|
||
|
|
<li> class: Records types are specified through class
|
||
|
|
declarations. A class declaration is like a Java class declaration.
|
||
|
|
It specifies a named record type and a list of fields that constitute records
|
||
|
|
of the type. Usage is illustrated in the following examples.
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h3>Examples</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>A simple DDL file links.jr with just one record declaration.
|
||
|
|
<pre><code>
|
||
|
|
module links {
|
||
|
|
class Link {
|
||
|
|
ustring URL;
|
||
|
|
boolean isRelative;
|
||
|
|
ustring anchorText;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<li> A DDL file outlinks.jr which includes another
|
||
|
|
<pre><code>
|
||
|
|
include "links.jr"
|
||
|
|
|
||
|
|
module outlinks {
|
||
|
|
class OutLinks {
|
||
|
|
ustring baseURL;
|
||
|
|
vector<links.Link> outLinks;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h2>Code Generation</h2>
|
||
|
|
|
||
|
|
The Hadoop translator is written in Java. Invocation is done by executing a
|
||
|
|
wrapper shell script named named rcc. It takes a list of
|
||
|
|
record description files as a mandatory argument and an
|
||
|
|
optional language argument (the default is Java) --language or
|
||
|
|
-l. Thus a typical invocation would look like:
|
||
|
|
<pre><code>
|
||
|
|
$ rcc -l C++ <filename> ...
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Target Language Mappings and Support</h2>
|
||
|
|
|
||
|
|
For all target languages, the unit of code generation is a record type.
|
||
|
|
For each record type, Hadoop generates code for serialization and
|
||
|
|
deserialization, record comparison and access to record members.
|
||
|
|
|
||
|
|
<h3>C++</h3>
|
||
|
|
|
||
|
|
Support for including Hadoop generated C++ code in applications comes in the
|
||
|
|
form of a header file recordio.hh which needs to be included in source
|
||
|
|
that uses Hadoop types and a library librecordio.a which applications need
|
||
|
|
to be linked with. The header declares the Hadoop C++ namespace which defines
|
||
|
|
appropriate types for the various primitives, the basic interfaces for
|
||
|
|
records and streams and enumerates the supported serialization encodings.
|
||
|
|
Declarations of these interfaces and a description of their semantics follow:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
namespace hadoop {
|
||
|
|
|
||
|
|
enum RecFormat { kBinary, kXML, kCSV };
|
||
|
|
|
||
|
|
class InStream {
|
||
|
|
public:
|
||
|
|
virtual ssize_t read(void *buf, size_t n) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
class OutStream {
|
||
|
|
public:
|
||
|
|
virtual ssize_t write(const void *buf, size_t n) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
class IOError : public runtime_error {
|
||
|
|
public:
|
||
|
|
explicit IOError(const std::string& msg);
|
||
|
|
};
|
||
|
|
|
||
|
|
class IArchive;
|
||
|
|
class OArchive;
|
||
|
|
|
||
|
|
class RecordReader {
|
||
|
|
public:
|
||
|
|
RecordReader(InStream& in, RecFormat fmt);
|
||
|
|
virtual ~RecordReader(void);
|
||
|
|
|
||
|
|
virtual void read(Record& rec);
|
||
|
|
};
|
||
|
|
|
||
|
|
class RecordWriter {
|
||
|
|
public:
|
||
|
|
RecordWriter(OutStream& out, RecFormat fmt);
|
||
|
|
virtual ~RecordWriter(void);
|
||
|
|
|
||
|
|
virtual void write(Record& rec);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
class Record {
|
||
|
|
public:
|
||
|
|
virtual std::string type(void) const = 0;
|
||
|
|
virtual std::string signature(void) const = 0;
|
||
|
|
protected:
|
||
|
|
virtual bool validate(void) const = 0;
|
||
|
|
|
||
|
|
virtual void
|
||
|
|
serialize(OArchive& oa, const std::string& tag) const = 0;
|
||
|
|
|
||
|
|
virtual void
|
||
|
|
deserialize(IArchive& ia, const std::string& tag) = 0;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li> RecFormat: An enumeration of the serialization encodings supported
|
||
|
|
by this implementation of Hadoop.
|
||
|
|
|
||
|
|
<li> InStream: A simple abstraction for an input stream. This has a
|
||
|
|
single public read method that reads n bytes from the stream into
|
||
|
|
the buffer buf. Has the same semantics as a blocking read system
|
||
|
|
call. Returns the number of bytes read or -1 if an error occurs.
|
||
|
|
|
||
|
|
<li> OutStream: A simple abstraction for an output stream. This has a
|
||
|
|
single write method that writes n bytes to the stream from the
|
||
|
|
buffer buf. Has the same semantics as a blocking write system
|
||
|
|
call. Returns the number of bytes written or -1 if an error occurs.
|
||
|
|
|
||
|
|
<li> RecordReader: A RecordReader reads records one at a time from
|
||
|
|
an underlying stream in a specified record format. The reader is instantiated
|
||
|
|
with a stream and a serialization format. It has a read method that
|
||
|
|
takes an instance of a record and deserializes the record from the stream.
|
||
|
|
|
||
|
|
<li> RecordWriter: A RecordWriter writes records one at a
|
||
|
|
time to an underlying stream in a specified record format. The writer is
|
||
|
|
instantiated with a stream and a serialization format. It has a
|
||
|
|
write method that takes an instance of a record and serializes the
|
||
|
|
record to the stream.
|
||
|
|
|
||
|
|
<li> Record: The base class for all generated record types. This has two
|
||
|
|
public methods type and signature that return the typename and the
|
||
|
|
type signature of the record.
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Two files are generated for each record file (note: not for each record). If a
|
||
|
|
record file is named "name.jr", the generated files are
|
||
|
|
"name.jr.cc" and "name.jr.hh" containing serialization
|
||
|
|
implementations and record type declarations respectively.
|
||
|
|
|
||
|
|
For each record in the DDL file, the generated header file will contain a
|
||
|
|
class definition corresponding to the record type, method definitions for the
|
||
|
|
generated type will be present in the '.cc' file. The generated class will
|
||
|
|
inherit from the abstract class hadoop::Record. The DDL files
|
||
|
|
module declaration determines the namespace the record belongs to.
|
||
|
|
Each '.' delimited token in the module declaration results in the
|
||
|
|
creation of a namespace. For instance, the declaration module docs.links
|
||
|
|
results in the creation of a docs namespace and a nested
|
||
|
|
docs::links namespace. In the preceding examples, the Link class
|
||
|
|
is placed in the links namespace. The header file corresponding to
|
||
|
|
the links.jr file will contain:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
namespace links {
|
||
|
|
class Link : public hadoop::Record {
|
||
|
|
// ....
|
||
|
|
};
|
||
|
|
};
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
Each field within the record will cause the generation of a private member
|
||
|
|
declaration of the appropriate type in the class declaration, and one or more
|
||
|
|
acccessor methods. The generated class will implement the serialize and
|
||
|
|
deserialize methods defined in hadoop::Record+. It will also
|
||
|
|
implement the inspection methods type and signature from
|
||
|
|
hadoop::Record. A default constructor and virtual destructor will also
|
||
|
|
be generated. Serialization code will read/write records into streams that
|
||
|
|
implement the hadoop::InStream and the hadoop::OutStream interfaces.
|
||
|
|
|
||
|
|
For each member of a record an accessor method is generated that returns
|
||
|
|
either the member or a reference to the member. For members that are returned
|
||
|
|
by value, a setter method is also generated. This is true for primitive
|
||
|
|
data members of the types byte, int, long, boolean, float and
|
||
|
|
double. For example, for a int field called MyField the folowing
|
||
|
|
code is generated.
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
...
|
||
|
|
private:
|
||
|
|
int32_t mMyField;
|
||
|
|
...
|
||
|
|
public:
|
||
|
|
int32_t getMyField(void) const {
|
||
|
|
return mMyField;
|
||
|
|
};
|
||
|
|
|
||
|
|
void setMyField(int32_t m) {
|
||
|
|
mMyField = m;
|
||
|
|
};
|
||
|
|
...
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
For a ustring or buffer or composite field. The generated code
|
||
|
|
only contains accessors that return a reference to the field. A const
|
||
|
|
and a non-const accessor are generated. For example:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
...
|
||
|
|
private:
|
||
|
|
std::string mMyBuf;
|
||
|
|
...
|
||
|
|
public:
|
||
|
|
|
||
|
|
std::string& getMyBuf() {
|
||
|
|
return mMyBuf;
|
||
|
|
};
|
||
|
|
|
||
|
|
const std::string& getMyBuf() const {
|
||
|
|
return mMyBuf;
|
||
|
|
};
|
||
|
|
...
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h4>Examples</h4>
|
||
|
|
|
||
|
|
Suppose the inclrec.jr file contains:
|
||
|
|
<pre><code>
|
||
|
|
module inclrec {
|
||
|
|
class RI {
|
||
|
|
int I32;
|
||
|
|
double D;
|
||
|
|
ustring S;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
and the testrec.jr file contains:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
include "inclrec.jr"
|
||
|
|
module testrec {
|
||
|
|
class R {
|
||
|
|
vector<float> VF;
|
||
|
|
RI Rec;
|
||
|
|
buffer Buf;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
Then the invocation of rcc such as:
|
||
|
|
<pre><code>
|
||
|
|
$ rcc -l c++ inclrec.jr testrec.jr
|
||
|
|
</code></pre>
|
||
|
|
will result in generation of four files:
|
||
|
|
inclrec.jr.{cc,hh} and testrec.jr.{cc,hh}.
|
||
|
|
|
||
|
|
The inclrec.jr.hh will contain:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
#ifndef _INCLREC_JR_HH_
|
||
|
|
#define _INCLREC_JR_HH_
|
||
|
|
|
||
|
|
#include "recordio.hh"
|
||
|
|
|
||
|
|
namespace inclrec {
|
||
|
|
|
||
|
|
class RI : public hadoop::Record {
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
int32_t I32;
|
||
|
|
double D;
|
||
|
|
std::string S;
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
RI(void);
|
||
|
|
virtual ~RI(void);
|
||
|
|
|
||
|
|
virtual bool operator==(const RI& peer) const;
|
||
|
|
virtual bool operator<(const RI& peer) const;
|
||
|
|
|
||
|
|
virtual int32_t getI32(void) const { return I32; }
|
||
|
|
virtual void setI32(int32_t v) { I32 = v; }
|
||
|
|
|
||
|
|
virtual double getD(void) const { return D; }
|
||
|
|
virtual void setD(double v) { D = v; }
|
||
|
|
|
||
|
|
virtual std::string& getS(void) const { return S; }
|
||
|
|
virtual const std::string& getS(void) const { return S; }
|
||
|
|
|
||
|
|
virtual std::string type(void) const;
|
||
|
|
virtual std::string signature(void) const;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
|
||
|
|
virtual void serialize(hadoop::OArchive& a) const;
|
||
|
|
virtual void deserialize(hadoop::IArchive& a);
|
||
|
|
};
|
||
|
|
} // end namespace inclrec
|
||
|
|
|
||
|
|
#endif /* _INCLREC_JR_HH_ */
|
||
|
|
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
The testrec.jr.hh file will contain:
|
||
|
|
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
|
||
|
|
#ifndef _TESTREC_JR_HH_
|
||
|
|
#define _TESTREC_JR_HH_
|
||
|
|
|
||
|
|
#include "inclrec.jr.hh"
|
||
|
|
|
||
|
|
namespace testrec {
|
||
|
|
class R : public hadoop::Record {
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
std::vector<float> VF;
|
||
|
|
inclrec::RI Rec;
|
||
|
|
std::string Buf;
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
R(void);
|
||
|
|
virtual ~R(void);
|
||
|
|
|
||
|
|
virtual bool operator==(const R& peer) const;
|
||
|
|
virtual bool operator<(const R& peer) const;
|
||
|
|
|
||
|
|
virtual std::vector<float>& getVF(void) const;
|
||
|
|
virtual const std::vector<float>& getVF(void) const;
|
||
|
|
|
||
|
|
virtual std::string& getBuf(void) const ;
|
||
|
|
virtual const std::string& getBuf(void) const;
|
||
|
|
|
||
|
|
virtual inclrec::RI& getRec(void) const;
|
||
|
|
virtual const inclrec::RI& getRec(void) const;
|
||
|
|
|
||
|
|
virtual bool serialize(hadoop::OutArchive& a) const;
|
||
|
|
virtual bool deserialize(hadoop::InArchive& a);
|
||
|
|
|
||
|
|
virtual std::string type(void) const;
|
||
|
|
virtual std::string signature(void) const;
|
||
|
|
};
|
||
|
|
}; // end namespace testrec
|
||
|
|
#endif /* _TESTREC_JR_HH_ */
|
||
|
|
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h3>Java</h3>
|
||
|
|
|
||
|
|
Code generation for Java is similar to that for C++. A Java class is generated
|
||
|
|
for each record type with private members corresponding to the fields. Getters
|
||
|
|
and setters for fields are also generated. Some differences arise in the
|
||
|
|
way comparison is expressed and in the mapping of modules to packages and
|
||
|
|
classes to files. For equality testing, an equals method is generated
|
||
|
|
for each record type. As per Java requirements a hashCode method is also
|
||
|
|
generated. For comparison a compareTo method is generated for each
|
||
|
|
record type. This has the semantics as defined by the Java Comparable
|
||
|
|
interface, that is, the method returns a negative integer, zero, or a positive
|
||
|
|
integer as the invoked object is less than, equal to, or greater than the
|
||
|
|
comparison parameter.
|
||
|
|
|
||
|
|
A .java file is generated per record type as opposed to per DDL
|
||
|
|
file as in C++. The module declaration translates to a Java
|
||
|
|
package declaration. The module name maps to an identical Java package
|
||
|
|
name. In addition to this mapping, the DDL compiler creates the appropriate
|
||
|
|
directory hierarchy for the package and places the generated .java
|
||
|
|
files in the correct directories.
|
||
|
|
|
||
|
|
<h2>Mapping Summary</h2>
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
DDL Type C++ Type Java Type
|
||
|
|
|
||
|
|
boolean bool boolean
|
||
|
|
byte int8_t byte
|
||
|
|
int int32_t int
|
||
|
|
long int64_t long
|
||
|
|
float float float
|
||
|
|
double double double
|
||
|
|
ustring std::string java.lang.String
|
||
|
|
buffer std::string org.apache.hadoop.record.Buffer
|
||
|
|
class type class type class type
|
||
|
|
vector<type> std::vector<type> java.util.ArrayList<type>
|
||
|
|
map<type,type> std::map<type,type> java.util.TreeMap<type,type>
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h2>Data encodings</h2>
|
||
|
|
|
||
|
|
This section describes the format of the data encodings supported by Hadoop.
|
||
|
|
Currently, three data encodings are supported, namely binary, CSV and XML.
|
||
|
|
|
||
|
|
<h3>Binary Serialization Format</h3>
|
||
|
|
|
||
|
|
The binary data encoding format is fairly dense. Serialization of composite
|
||
|
|
types is simply defined as a concatenation of serializations of the constituent
|
||
|
|
elements (lengths are included in vectors and maps).
|
||
|
|
|
||
|
|
Composite types are serialized as follows:
|
||
|
|
<ul>
|
||
|
|
<li> class: Sequence of serialized members.
|
||
|
|
<li> vector: The number of elements serialized as an int. Followed by a
|
||
|
|
sequence of serialized elements.
|
||
|
|
<li> map: The number of key value pairs serialized as an int. Followed
|
||
|
|
by a sequence of serialized (key,value) pairs.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Serialization of primitives is more interesting, with a zero compression
|
||
|
|
optimization for integral types and normalization to UTF-8 for strings.
|
||
|
|
Primitive types are serialized as follows:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> byte: Represented by 1 byte, as is.
|
||
|
|
<li> boolean: Represented by 1-byte (0 or 1)
|
||
|
|
<li> int/long: Integers and longs are serialized zero compressed.
|
||
|
|
Represented as 1-byte if -120 <= value < 128. Otherwise, serialized as a
|
||
|
|
sequence of 2-5 bytes for ints, 2-9 bytes for longs. The first byte represents
|
||
|
|
the number of trailing bytes, N, as the negative number (-120-N). For example,
|
||
|
|
the number 1024 (0x400) is represented by the byte sequence 'x86 x04 x00'.
|
||
|
|
This doesn't help much for 4-byte integers but does a reasonably good job with
|
||
|
|
longs without bit twiddling.
|
||
|
|
<li> float/double: Serialized in IEEE 754 single and double precision
|
||
|
|
format in network byte order. This is the format used by Java.
|
||
|
|
<li> ustring: Serialized as 4-byte zero compressed length followed by
|
||
|
|
data encoded as UTF-8. Strings are normalized to UTF-8 regardless of native
|
||
|
|
language representation.
|
||
|
|
<li> buffer: Serialized as a 4-byte zero compressed length followed by the
|
||
|
|
raw bytes in the buffer.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>CSV Serialization Format</h3>
|
||
|
|
|
||
|
|
The CSV serialization format has a lot more structure than the "standard"
|
||
|
|
Excel CSV format, but we believe the additional structure is useful because
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> it makes parsing a lot easier without detracting too much from legibility
|
||
|
|
<li> the delimiters around composites make it obvious when one is reading a
|
||
|
|
sequence of Hadoop records
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Serialization formats for the various types are detailed in the grammar that
|
||
|
|
follows. The notable feature of the formats is the use of delimiters for
|
||
|
|
indicating the certain field types.
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> A string field begins with a single quote (').
|
||
|
|
<li> A buffer field begins with a sharp (#).
|
||
|
|
<li> A class, vector or map begins with 's{', 'v{' or 'm{' respectively and
|
||
|
|
ends with '}'.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
The CSV format can be described by the following grammar:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
record = primitive / struct / vector / map
|
||
|
|
primitive = boolean / int / long / float / double / ustring / buffer
|
||
|
|
|
||
|
|
boolean = "T" / "F"
|
||
|
|
int = ["-"] 1*DIGIT
|
||
|
|
long = ";" ["-"] 1*DIGIT
|
||
|
|
float = ["-"] 1*DIGIT "." 1*DIGIT ["E" / "e" ["-"] 1*DIGIT]
|
||
|
|
double = ";" ["-"] 1*DIGIT "." 1*DIGIT ["E" / "e" ["-"] 1*DIGIT]
|
||
|
|
|
||
|
|
ustring = "'" *(UTF8 char except NULL, LF, % and , / "%00" / "%0a" / "%25" / "%2c" )
|
||
|
|
|
||
|
|
buffer = "#" *(BYTE except NULL, LF, % and , / "%00" / "%0a" / "%25" / "%2c" )
|
||
|
|
|
||
|
|
struct = "s{" record *("," record) "}"
|
||
|
|
vector = "v{" [record *("," record)] "}"
|
||
|
|
map = "m{" [*(record "," record)] "}"
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
<h3>XML Serialization Format</h3>
|
||
|
|
|
||
|
|
The XML serialization format is the same used by Apache XML-RPC
|
||
|
|
(http://ws.apache.org/xmlrpc/types.html). This is an extension of the original
|
||
|
|
XML-RPC format and adds some additional data types. All record I/O types are
|
||
|
|
not directly expressible in this format, and access to a DDL is required in
|
||
|
|
order to convert these to valid types. All types primitive or composite are
|
||
|
|
represented by <value> elements. The particular XML-RPC type is
|
||
|
|
indicated by a nested element in the <value> element. The encoding for
|
||
|
|
records is always UTF-8. Primitive types are serialized as follows:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> byte: XML tag <ex:i1>. Values: 1-byte unsigned
|
||
|
|
integers represented in US-ASCII
|
||
|
|
<li> boolean: XML tag <boolean>. Values: "0" or "1"
|
||
|
|
<li> int: XML tags <i4> or <int>. Values: 4-byte
|
||
|
|
signed integers represented in US-ASCII.
|
||
|
|
<li> long: XML tag <ex:i8>. Values: 8-byte signed integers
|
||
|
|
represented in US-ASCII.
|
||
|
|
<li> float: XML tag <ex:float>. Values: Single precision
|
||
|
|
floating point numbers represented in US-ASCII.
|
||
|
|
<li> double: XML tag <double>. Values: Double precision
|
||
|
|
floating point numbers represented in US-ASCII.
|
||
|
|
<li> ustring: XML tag <;string>. Values: String values
|
||
|
|
represented as UTF-8. XML does not permit all Unicode characters in literal
|
||
|
|
data. In particular, NULLs and control chars are not allowed. Additionally,
|
||
|
|
XML processors are required to replace carriage returns with line feeds and to
|
||
|
|
replace CRLF sequences with line feeds. Programming languages that we work
|
||
|
|
with do not impose these restrictions on string types. To work around these
|
||
|
|
restrictions, disallowed characters and CRs are percent escaped in strings.
|
||
|
|
The '%' character is also percent escaped.
|
||
|
|
<li> buffer: XML tag <string&>. Values: Arbitrary binary
|
||
|
|
data. Represented as hexBinary, each byte is replaced by its 2-byte
|
||
|
|
hexadecimal representation.
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
Composite types are serialized as follows:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li> class: XML tag <struct>. A struct is a sequence of
|
||
|
|
<member> elements. Each <member> element has a <name>
|
||
|
|
element and a <value> element. The <name> is a string that must
|
||
|
|
match /[a-zA-Z][a-zA-Z0-9_]*/. The value of the member is represented
|
||
|
|
by a <value> element.
|
||
|
|
|
||
|
|
<li> vector: XML tag <array<. An <array> contains a
|
||
|
|
single <data> element. The <data> element is a sequence of
|
||
|
|
<value> elements each of which represents an element of the vector.
|
||
|
|
|
||
|
|
<li> map: XML tag <array>. Same as vector.
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
For example:
|
||
|
|
|
||
|
|
<pre><code>
|
||
|
|
class {
|
||
|
|
int MY_INT; // value 5
|
||
|
|
vector<float> MY_VEC; // values 0.1, -0.89, 2.45e4
|
||
|
|
buffer MY_BUF; // value '\00\n\tabc%'
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
is serialized as
|
||
|
|
|
||
|
|
<pre><code class="XML">
|
||
|
|
<value>
|
||
|
|
<struct>
|
||
|
|
<member>
|
||
|
|
<name>MY_INT</name>
|
||
|
|
<value><i4>5</i4></value>
|
||
|
|
</member>
|
||
|
|
<member>
|
||
|
|
<name>MY_VEC</name>
|
||
|
|
<value>
|
||
|
|
<array>
|
||
|
|
<data>
|
||
|
|
<value><ex:float>0.1</ex:float></value>
|
||
|
|
<value><ex:float>-0.89</ex:float></value>
|
||
|
|
<value><ex:float>2.45e4</ex:float></value>
|
||
|
|
</data>
|
||
|
|
</array>
|
||
|
|
</value>
|
||
|
|
</member>
|
||
|
|
<member>
|
||
|
|
<name>MY_BUF</name>
|
||
|
|
<value><string>%00\n\tabc%25</string></value>
|
||
|
|
</member>
|
||
|
|
</struct>
|
||
|
|
</value>
|
||
|
|
</code></pre>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.record.compiler">
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.CodeBuffer -->
|
||
|
|
<class name="CodeBuffer" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<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 wrapper around StringBuffer that automatically does indentation
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.CodeBuffer -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.Consts -->
|
||
|
|
<class name="Consts" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<field name="RIO_PREFIX" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RTI_VAR" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RTI_FILTER" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RTI_FILTER_FIELDS" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RECORD_OUTPUT" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RECORD_INPUT" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="TAG" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[const definitions for Record I/O compiler
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.Consts -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JBoolean -->
|
||
|
|
<class name="JBoolean" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JBoolean"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JBoolean]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JBoolean -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JBuffer -->
|
||
|
|
<class name="JBuffer" extends="org.apache.hadoop.record.compiler.JCompType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JBuffer"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JBuffer]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Code generator for "buffer" type.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JBuffer -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JByte -->
|
||
|
|
<class name="JByte" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JByte"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Code generator for "byte" type.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JByte -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JDouble -->
|
||
|
|
<class name="JDouble" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JDouble"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JDouble]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JDouble -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JField -->
|
||
|
|
<class name="JField" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JField" type="java.lang.String, T"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JField]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A thin wrappper around record field.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JField -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JFile -->
|
||
|
|
<class name="JFile" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JFile" type="java.lang.String, java.util.ArrayList, java.util.ArrayList"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JFile
|
||
|
|
|
||
|
|
@param name possibly full pathname to the file
|
||
|
|
@param inclFiles included files (as JFile)
|
||
|
|
@param recList List of records defined within this file]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="genCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="language" type="java.lang.String"/>
|
||
|
|
<param name="destDir" type="java.lang.String"/>
|
||
|
|
<param name="options" type="java.util.ArrayList"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Generate record code in given language. Language should be all
|
||
|
|
lowercase.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Container for the Hadoop Record DDL.
|
||
|
|
The main components of the file are filename, list of included files,
|
||
|
|
and records defined in that file.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JFile -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JFloat -->
|
||
|
|
<class name="JFloat" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JFloat"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JFloat]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JFloat -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JInt -->
|
||
|
|
<class name="JInt" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JInt"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JInt]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Code generator for "int" type
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JInt -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JLong -->
|
||
|
|
<class name="JLong" extends="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JLong"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JLong]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Code generator for "long" type
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JLong -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JMap -->
|
||
|
|
<class name="JMap" extends="org.apache.hadoop.record.compiler.JCompType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JMap" type="org.apache.hadoop.record.compiler.JType, org.apache.hadoop.record.compiler.JType"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JMap]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JMap -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JRecord -->
|
||
|
|
<class name="JRecord" extends="org.apache.hadoop.record.compiler.JCompType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JRecord" type="java.lang.String, java.util.ArrayList"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JRecord]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JRecord -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JString -->
|
||
|
|
<class name="JString" extends="org.apache.hadoop.record.compiler.JCompType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JString"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JString]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JString -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JType -->
|
||
|
|
<class name="JType" extends="java.lang.Object"
|
||
|
|
abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JType"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Abstract Base class for all types supported by Hadoop Record I/O.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JType -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.JVector -->
|
||
|
|
<class name="JVector" extends="org.apache.hadoop.record.compiler.JCompType"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="JVector" type="org.apache.hadoop.record.compiler.JType"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of JVector]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.JVector -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
(DEPRECATED) This package contains classes needed for code generation
|
||
|
|
from the hadoop record compiler. CppGenerator and JavaGenerator
|
||
|
|
are the main entry points from the parser. There are classes
|
||
|
|
corrsponding to every primitive type and compound type
|
||
|
|
included in Hadoop record I/O syntax.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
|
||
|
|
</p>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.record.compiler.ant">
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.ant.RccTask -->
|
||
|
|
<class name="RccTask" extends="org.apache.tools.ant.Task"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="RccTask"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Creates a new instance of RccTask]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="setLanguage"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="language" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the output language option
|
||
|
|
@param language "java"/"c++"]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="file" type="java.io.File"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets the record definition file attribute
|
||
|
|
@param file record definition file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setFailonerror"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="flag" type="boolean"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Given multiple files (via fileset), set the error handling behavior
|
||
|
|
@param flag true will throw build exception in case of failure (default)]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setDestdir"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dir" type="java.io.File"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Sets directory where output files will be generated
|
||
|
|
@param dir output directory]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addFileset"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="set" type="org.apache.tools.ant.types.FileSet"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds a fileset that can consist of one or more files
|
||
|
|
@param set Set of record definition files]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="execute"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="BuildException" type="org.apache.tools.ant.BuildException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Invoke the Hadoop record compiler on each record definition file]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Hadoop record compiler ant Task
|
||
|
|
<p> This task takes the given record definition files and compiles them into
|
||
|
|
java or c++
|
||
|
|
files. It is then up to the user to compile the generated files.
|
||
|
|
|
||
|
|
<p> The task requires the <code>file</code> or the nested fileset element to be
|
||
|
|
specified. Optional attributes are <code>language</code> (set the output
|
||
|
|
language, default is "java"),
|
||
|
|
<code>destdir</code> (name of the destination directory for generated java/c++
|
||
|
|
code, default is ".") and <code>failonerror</code> (specifies error handling
|
||
|
|
behavior. default is true).
|
||
|
|
<p><h4>Usage</h4>
|
||
|
|
<pre>
|
||
|
|
<recordcc
|
||
|
|
destdir="${basedir}/gensrc"
|
||
|
|
language="java">
|
||
|
|
<fileset include="**\/*.jr" />
|
||
|
|
</recordcc>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.ant.RccTask -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.record.compiler.generated">
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.ParseException -->
|
||
|
|
<class name="ParseException" extends="java.lang.Exception"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="ParseException" type="org.apache.hadoop.record.compiler.generated.Token, int[][], java.lang.String[]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This constructor is used by the method "generateParseException"
|
||
|
|
in the generated parser. Calling this constructor generates
|
||
|
|
a new object of this type with the fields "currentToken",
|
||
|
|
"expectedTokenSequences", and "tokenImage" set. The boolean
|
||
|
|
flag "specialConstructor" is also set to true to indicate that
|
||
|
|
this constructor was used to create this object.
|
||
|
|
This constructor calls its super class with the empty string
|
||
|
|
to force the "toString" method of parent class "Throwable" to
|
||
|
|
print the error message in the form:
|
||
|
|
ParseException: <result of getMessage>]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="ParseException"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The following constructors are for use by you for whatever
|
||
|
|
purpose you can think of. Constructing the exception in this
|
||
|
|
manner makes the exception behave in the normal way - i.e., as
|
||
|
|
documented in the class "Throwable". The fields "errorToken",
|
||
|
|
"expectedTokenSequences", and "tokenImage" do not contain
|
||
|
|
relevant information. The JavaCC generated code does not use
|
||
|
|
these constructors.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="ParseException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getMessage" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This method has the standard behavior when this object has been
|
||
|
|
created using the standard constructors. Otherwise, it uses
|
||
|
|
"currentToken" and "expectedTokenSequences" to generate a parse
|
||
|
|
error message and returns it. If this object has been created
|
||
|
|
due to a parse error, and you do not catch it (it gets thrown
|
||
|
|
from the parser), then this method is called during the printing
|
||
|
|
of the final stack trace, and hence the correct error message
|
||
|
|
gets displayed.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="add_escapes" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="str" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Used to convert raw characters to their escaped version
|
||
|
|
when these raw version cannot be used as part of an ASCII
|
||
|
|
string literal.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="specialConstructor" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This variable determines which constructor was used to create
|
||
|
|
this object and thereby affects the semantics of the
|
||
|
|
"getMessage" method (see below).]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="currentToken" type="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This is the last token that has been consumed successfully. If
|
||
|
|
this object has been created due to a parse error, the token
|
||
|
|
followng this token will (therefore) be the first error token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="expectedTokenSequences" type="int[][]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Each entry in this array is an array of integers. Each array
|
||
|
|
of integers represents a sequence of tokens (by their ordinal
|
||
|
|
values) that is expected at this point of the parse.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="tokenImage" type="java.lang.String[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This is a reference to the "tokenImage" array of the generated
|
||
|
|
parser within which the parse error occurred. This array is
|
||
|
|
defined in the generated ...Constants interface.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="eol" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The end of line string for this machine.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This exception is thrown when parse errors are encountered.
|
||
|
|
You can explicitly create objects of this exception type by
|
||
|
|
calling the method generateParseException in the generated
|
||
|
|
parser.
|
||
|
|
|
||
|
|
You can modify this class to customize your error reporting
|
||
|
|
mechanisms so long as you retain the public fields.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.ParseException -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.Rcc -->
|
||
|
|
<class name="Rcc" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
|
||
|
|
<constructor name="Rcc" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Rcc" type="java.io.InputStream, java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Rcc" type="java.io.Reader"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Rcc" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
|
||
|
|
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[]"/>
|
||
|
|
</method>
|
||
|
|
<method name="usage"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="driver" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="args" type="java.lang.String[]"/>
|
||
|
|
</method>
|
||
|
|
<method name="Input" return="org.apache.hadoop.record.compiler.JFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Include" return="org.apache.hadoop.record.compiler.JFile"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Module" return="java.util.ArrayList"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="ModuleName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="RecordList" return="java.util.ArrayList"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Record" return="org.apache.hadoop.record.compiler.JRecord"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Field" return="org.apache.hadoop.record.compiler.JField"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Type" return="org.apache.hadoop.record.compiler.JType"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Map" return="org.apache.hadoop.record.compiler.JMap"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="Vector" return="org.apache.hadoop.record.compiler.JVector"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="ParseException" type="org.apache.hadoop.record.compiler.generated.ParseException"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.InputStream"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.InputStream"/>
|
||
|
|
<param name="encoding" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.Reader"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tm" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"/>
|
||
|
|
</method>
|
||
|
|
<method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getToken" return="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="index" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="generateParseException" return="org.apache.hadoop.record.compiler.generated.ParseException"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="enable_tracing"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="disable_tracing"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<field name="token_source" type="org.apache.hadoop.record.compiler.generated.RccTokenManager"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="token" type="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="jj_nt" type="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.Rcc -->
|
||
|
|
<!-- start interface org.apache.hadoop.record.compiler.generated.RccConstants -->
|
||
|
|
<interface name="RccConstants" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<field name="EOF" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="MODULE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RECORD_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="INCLUDE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="BYTE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="BOOLEAN_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="INT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="LONG_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="FLOAT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="DOUBLE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="USTRING_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="BUFFER_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="VECTOR_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="MAP_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="LBRACE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="RBRACE_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="LT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="GT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="SEMICOLON_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="COMMA_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="DOT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="CSTRING_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="IDENT_TKN" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="DEFAULT" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="WithinOneLineComment" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="WithinMultiLineComment" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="tokenImage" type="java.lang.String[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.record.compiler.generated.RccConstants -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
|
||
|
|
<class name="RccTokenManager" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<implements name="org.apache.hadoop.record.compiler.generated.RccConstants"/>
|
||
|
|
<constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="RccTokenManager" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="setDebugStream"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="ds" type="java.io.PrintStream"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"/>
|
||
|
|
<param name="lexState" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="SwitchTo"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="lexState" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="jjFillToken" return="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getNextToken" return="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<field name="debugStream" type="java.io.PrintStream"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="jjstrLiteralImages" type="java.lang.String[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="lexStateNames" type="java.lang.String[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="jjnewLexState" type="int[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="input_stream" type="org.apache.hadoop.record.compiler.generated.SimpleCharStream"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="curChar" type="char"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.RccTokenManager -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
|
||
|
|
<class name="SimpleCharStream" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.Reader, int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.Reader, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.Reader"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream, int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream, java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="SimpleCharStream" type="java.io.InputStream"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="setTabSize"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="getTabSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="i" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="ExpandBuff"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="wrapAround" type="boolean"/>
|
||
|
|
</method>
|
||
|
|
<method name="FillBuff"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="BeginToken" return="char"
|
||
|
|
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="UpdateLineColumn"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="c" type="char"/>
|
||
|
|
</method>
|
||
|
|
<method name="readChar" return="char"
|
||
|
|
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="getEndColumn" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getEndLine" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getBeginColumn" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="getBeginLine" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="backup"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="amount" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.Reader"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
<param name="buffersize" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.Reader"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.Reader"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
<param name="encoding" type="java.lang.String"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
<param name="buffersize" type="int"/>
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
<param name="buffersize" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
<param name="encoding" type="java.lang.String"/>
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
<param name="encoding" type="java.lang.String"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
<exception name="UnsupportedEncodingException" type="java.io.UnsupportedEncodingException"/>
|
||
|
|
</method>
|
||
|
|
<method name="ReInit"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dstream" type="java.io.InputStream"/>
|
||
|
|
<param name="startline" type="int"/>
|
||
|
|
<param name="startcolumn" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="GetImage" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="GetSuffix" return="char[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="len" type="int"/>
|
||
|
|
</method>
|
||
|
|
<method name="Done"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="adjustBeginLineColumn"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="newLine" type="int"/>
|
||
|
|
<param name="newCol" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Method to adjust line and column numbers for the start of a token.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="staticFlag" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="bufpos" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="bufline" type="int[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="bufcolumn" type="int[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="column" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="line" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="prevCharIsCR" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="prevCharIsLF" type="boolean"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="inputStream" type="java.io.Reader"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="buffer" type="char[]"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="maxNextCharInd" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="inBuf" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="tabSize" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An implementation of interface CharStream, where the stream is assumed to
|
||
|
|
contain only ASCII characters (without unicode processing).
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.SimpleCharStream -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.Token -->
|
||
|
|
<class name="Token" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="Token"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<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 the image.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newToken" return="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="ofKind" type="int"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a new Token object, by default. However, if you want, you
|
||
|
|
can create and return subclass objects based on the value of ofKind.
|
||
|
|
Simply add the cases to the switch for all those special cases.
|
||
|
|
For example, if you have a subclass of Token called IDToken that
|
||
|
|
you want to create if ofKind is ID, simlpy add something like :
|
||
|
|
|
||
|
|
case MyParserConstants.ID : return new IDToken();
|
||
|
|
|
||
|
|
to the following switch statement. Then you can cast matchedToken
|
||
|
|
variable to the appropriate type and use it in your lexical actions.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="kind" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[An integer that describes the kind of this token. This numbering
|
||
|
|
system is determined by JavaCCParser, and a table of these numbers is
|
||
|
|
stored in the file ...Constants.java.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="beginLine" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[beginLine and beginColumn describe the position of the first character
|
||
|
|
of this token; endLine and endColumn describe the position of the
|
||
|
|
last character of this token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="beginColumn" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[beginLine and beginColumn describe the position of the first character
|
||
|
|
of this token; endLine and endColumn describe the position of the
|
||
|
|
last character of this token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="endLine" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[beginLine and beginColumn describe the position of the first character
|
||
|
|
of this token; endLine and endColumn describe the position of the
|
||
|
|
last character of this token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="endColumn" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[beginLine and beginColumn describe the position of the first character
|
||
|
|
of this token; endLine and endColumn describe the position of the
|
||
|
|
last character of this token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="image" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The string image of the token.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="next" type="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A reference to the next regular (non-special) token from the input
|
||
|
|
stream. If this is the last token from the input stream, or if the
|
||
|
|
token manager has not read tokens beyond this one, this field is
|
||
|
|
set to null. This is true only if this token is also a regular
|
||
|
|
token. Otherwise, see below for a description of the contents of
|
||
|
|
this field.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="specialToken" type="org.apache.hadoop.record.compiler.generated.Token"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This field is used to access special tokens that occur prior to this
|
||
|
|
token, but after the immediately preceding regular (non-special) token.
|
||
|
|
If there are no such special tokens, this field is set to null.
|
||
|
|
When there are more than one such special token, this field refers
|
||
|
|
to the last of these special tokens, which in turn refers to the next
|
||
|
|
previous special token through its specialToken field, and so on
|
||
|
|
until the first special token (whose specialToken field is null).
|
||
|
|
The next fields of special tokens refer to other special tokens that
|
||
|
|
immediately follow it (without an intervening regular token). If there
|
||
|
|
is no such token, this field is null.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Describes the input token stream.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.Token -->
|
||
|
|
<!-- start class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
|
||
|
|
<class name="TokenMgrError" extends="java.lang.Error"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="TokenMgrError"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="TokenMgrError" type="java.lang.String, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="TokenMgrError" type="boolean, int, int, int, java.lang.String, char, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="addEscapes" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="true" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="str" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Replaces unprintable characters by their espaced (or unicode escaped)
|
||
|
|
equivalents in the given string]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="LexicalError" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="EOFSeen" type="boolean"/>
|
||
|
|
<param name="lexState" type="int"/>
|
||
|
|
<param name="errorLine" type="int"/>
|
||
|
|
<param name="errorColumn" type="int"/>
|
||
|
|
<param name="errorAfter" type="java.lang.String"/>
|
||
|
|
<param name="curChar" type="char"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Returns a detailed message for the Error when it is thrown by the
|
||
|
|
token manager to indicate a lexical error.
|
||
|
|
Parameters :
|
||
|
|
EOFSeen : indicates if EOF caused the lexicl error
|
||
|
|
curLexState : lexical state in which this error occured
|
||
|
|
errorLine : line number when the error occured
|
||
|
|
errorColumn : column number when the error occured
|
||
|
|
errorAfter : prefix that was seen before this error occured
|
||
|
|
curchar : the offending character
|
||
|
|
Note: You can customize the lexical error message by modifying this method.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getMessage" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[You can also modify the body of this method to customize your error messages.
|
||
|
|
For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
|
||
|
|
of end-users concern, so you can return something like :
|
||
|
|
|
||
|
|
"Internal Error : Please file a bug report .... "
|
||
|
|
|
||
|
|
from this method for such cases in the release version of your parser.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.compiler.generated.TokenMgrError -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[<p>
|
||
|
|
(DEPRECATED) This package contains code generated by JavaCC from the
|
||
|
|
Hadoop record syntax file rcc.jj. For details about the
|
||
|
|
record file syntax please @see org.apache.hadoop.record.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
|
||
|
|
</p>]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.record.meta">
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.FieldTypeInfo -->
|
||
|
|
<class name="FieldTypeInfo" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="getTypeID" return="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[get the field's TypeID object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFieldID" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[get the field's id (name)]]>
|
||
|
|
</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[Two FieldTypeInfos are equal if ach of their fields matches]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[We use a basic hashcode implementation, since this class will likely not
|
||
|
|
be used as a hashmap key]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="equals" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="ti" type="org.apache.hadoop.record.meta.FieldTypeInfo"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents a type information for a field, which is made up of its
|
||
|
|
ID (name) and its type (a TypeID object).
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.FieldTypeInfo -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.MapTypeID -->
|
||
|
|
<class name="MapTypeID" extends="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="MapTypeID" type="org.apache.hadoop.record.meta.TypeID, org.apache.hadoop.record.meta.TypeID"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getKeyTypeID" return="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[get the TypeID of the map's key element]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getValueTypeID" return="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[get the TypeID of the map's value element]]>
|
||
|
|
</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[Two map typeIDs are equal if their constituent elements have the
|
||
|
|
same type]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[We use a basic hashcode implementation, since this class will likely not
|
||
|
|
be used as a hashmap key]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents typeID for a Map
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.MapTypeID -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.RecordTypeInfo -->
|
||
|
|
<class name="RecordTypeInfo" extends="org.apache.hadoop.record.Record"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="RecordTypeInfo"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create an empty RecordTypeInfo object.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="RecordTypeInfo" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a RecordTypeInfo object representing a record with the given name
|
||
|
|
@param name Name of the record]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[return the name of the record]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setName"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[set the name of the record]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addField"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="fieldName" type="java.lang.String"/>
|
||
|
|
<param name="tid" type="org.apache.hadoop.record.meta.TypeID"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Add a field.
|
||
|
|
@param fieldName Name of the field
|
||
|
|
@param tid Type ID of the field]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getFieldTypeInfos" return="java.util.Collection"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return a collection of field type infos]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getNestedStructTypeInfo" return="org.apache.hadoop.record.meta.RecordTypeInfo"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the type info of a nested record. We only consider nesting
|
||
|
|
to one level.
|
||
|
|
@param name Name of the nested record]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="serialize"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rout" type="org.apache.hadoop.record.RecordOutput"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Serialize the type information for a record]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="deserialize"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rin" type="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Deserialize the type information for a record]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="compareTo" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="peer_" type="java.lang.Object"/>
|
||
|
|
<exception name="ClassCastException" type="java.lang.ClassCastException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This class doesn't implement Comparable as it's not meant to be used
|
||
|
|
for anything besides de/serializing.
|
||
|
|
So we always throw an exception.
|
||
|
|
Not implemented. Always returns 0 if another RecordTypeInfo is passed in.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A record's Type Information object which can read/write itself.
|
||
|
|
|
||
|
|
Type information for a record comprises metadata about the record,
|
||
|
|
as well as a collection of type information for each field in the record.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.RecordTypeInfo -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.StructTypeID -->
|
||
|
|
<class name="StructTypeID" extends="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="StructTypeID" type="org.apache.hadoop.record.meta.RecordTypeInfo"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a StructTypeID based on the RecordTypeInfo of some record]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="getFieldTypeInfos" return="java.util.Collection"
|
||
|
|
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>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents typeID for a struct
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.StructTypeID -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.TypeID -->
|
||
|
|
<class name="TypeID" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="getTypeVal" return="byte"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the type value. One of the constants in RIOType.]]>
|
||
|
|
</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[Two base typeIDs are equal if they refer to the same type]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[We use a basic hashcode implementation, since this class will likely not
|
||
|
|
be used as a hashmap key]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="BoolTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constant classes for the basic types, so we can share them.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="BufferTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="ByteTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="DoubleTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="FloatTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="IntTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="LongTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="StringTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="typeVal" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents typeID for basic types.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.TypeID -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.TypeID.RIOType -->
|
||
|
|
<class name="TypeID.RIOType" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="TypeID.RIOType"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<field name="BOOL" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="BUFFER" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="BYTE" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="DOUBLE" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="FLOAT" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="INT" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="LONG" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="MAP" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="STRING" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="STRUCT" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="VECTOR" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[constants representing the IDL types we support]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.TypeID.RIOType -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.Utils -->
|
||
|
|
<class name="Utils" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<method name="skip"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="rin" type="org.apache.hadoop.record.RecordInput"/>
|
||
|
|
<param name="tag" type="java.lang.String"/>
|
||
|
|
<param name="typeID" type="org.apache.hadoop.record.meta.TypeID"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[read/skip bytes from stream based on a type]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Various utility functions for Hadooop record I/O platform.
|
||
|
|
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.Utils -->
|
||
|
|
<!-- start class org.apache.hadoop.record.meta.VectorTypeID -->
|
||
|
|
<class name="VectorTypeID" extends="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="Replaced by lEsS_tHaNa href=quote_cHaRhttp://hadoop.apache.org/avro/quote_cHaR>AvrolEsS_tHaN/a>.">
|
||
|
|
<constructor name="VectorTypeID" type="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getElementTypeID" return="org.apache.hadoop.record.meta.TypeID"
|
||
|
|
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[Two vector typeIDs are equal if their constituent elements have the
|
||
|
|
same type]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hashCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[We use a basic hashcode implementation, since this class will likely not
|
||
|
|
be used as a hashmap key]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Represents typeID for vector.
|
||
|
|
@deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.record.meta.VectorTypeID -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.security">
|
||
|
|
<!-- start class org.apache.hadoop.security.SaslRpcServer.AuthMethod -->
|
||
|
|
<class name="SaslRpcServer.AuthMethod" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
|
||
|
|
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="getMechanismName" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the SASL mechanism name]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="read" return="org.apache.hadoop.security.SaslRpcServer.AuthMethod"
|
||
|
|
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[Read from in]]>
|
||
|
|
</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[Write to out]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="code" type="byte"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The code for this method.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="mechanismName" type="java.lang.String"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="authenticationMethod" type="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Authentication method]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.SaslRpcServer.AuthMethod -->
|
||
|
|
<!-- start class org.apache.hadoop.security.SaslRpcServer.SaslDigestCallbackHandler -->
|
||
|
|
<class name="SaslRpcServer.SaslDigestCallbackHandler" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="javax.security.auth.callback.CallbackHandler"/>
|
||
|
|
<constructor name="SaslRpcServer.SaslDigestCallbackHandler" type="org.apache.hadoop.security.token.SecretManager, org.apache.hadoop.ipc.Server.Connection"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="handle"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="callbacks" type="javax.security.auth.callback.Callback[]"/>
|
||
|
|
<exception name="SecretManager.InvalidToken" type="org.apache.hadoop.security.token.SecretManager.InvalidToken"/>
|
||
|
|
<exception name="UnsupportedCallbackException" type="javax.security.auth.callback.UnsupportedCallbackException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[CallbackHandler for SASL DIGEST-MD5 mechanism]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.SaslRpcServer.SaslDigestCallbackHandler -->
|
||
|
|
<!-- start class org.apache.hadoop.security.SaslRpcServer.SaslGssCallbackHandler -->
|
||
|
|
<class name="SaslRpcServer.SaslGssCallbackHandler" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="javax.security.auth.callback.CallbackHandler"/>
|
||
|
|
<constructor name="SaslRpcServer.SaslGssCallbackHandler"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="handle"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="callbacks" type="javax.security.auth.callback.Callback[]"/>
|
||
|
|
<exception name="UnsupportedCallbackException" type="javax.security.auth.callback.UnsupportedCallbackException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[{@inheritDoc}]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[CallbackHandler for SASL GSSAPI Kerberos mechanism]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.SaslRpcServer.SaslGssCallbackHandler -->
|
||
|
|
<!-- start class org.apache.hadoop.security.SaslRpcServer.SaslStatus -->
|
||
|
|
<class name="SaslRpcServer.SaslStatus" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.security.SaslRpcServer.SaslStatus[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.security.SaslRpcServer.SaslStatus"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
<field name="state" type="int"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.SaslRpcServer.SaslStatus -->
|
||
|
|
<!-- start class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
|
||
|
|
<class name="UserGroupInformation.AuthenticationMethod" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="name" type="java.lang.String"/>
|
||
|
|
</method>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.security.authorize">
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.security.token">
|
||
|
|
<!-- start class org.apache.hadoop.security.token.SecretManager.InvalidToken -->
|
||
|
|
<class name="SecretManager.InvalidToken" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="SecretManager.InvalidToken" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The token was invalid and the message explains why.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.token.SecretManager.InvalidToken -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.security.token.delegation">
|
||
|
|
<!-- start class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation -->
|
||
|
|
<class name="AbstractDelegationTokenSecretManager.DelegationTokenInformation" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="AbstractDelegationTokenSecretManager.DelegationTokenInformation" type="long, byte[]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getRenewDate" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[returns renew date]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Class to encapsulate a token's renew date and password.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.security.token.delegation.AbstractDelegationTokenSecretManager.DelegationTokenInformation -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.util">
|
||
|
|
<!-- start class org.apache.hadoop.util.DiskChecker.DiskErrorException -->
|
||
|
|
<class name="DiskChecker.DiskErrorException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="DiskChecker.DiskErrorException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.DiskChecker.DiskErrorException -->
|
||
|
|
<!-- start class org.apache.hadoop.util.DiskChecker.DiskOutOfSpaceException -->
|
||
|
|
<class name="DiskChecker.DiskOutOfSpaceException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="DiskChecker.DiskOutOfSpaceException" type="java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.DiskChecker.DiskOutOfSpaceException -->
|
||
|
|
<!-- start interface org.apache.hadoop.util.Progressable -->
|
||
|
|
<interface name="Progressable" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="progress"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Report progress to the Hadoop framework.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A facility for reporting progress.
|
||
|
|
|
||
|
|
<p>Clients and/or applications can use the provided <code>Progressable</code>
|
||
|
|
to explicitly report progress to the Hadoop framework. This is especially
|
||
|
|
important for operations which take an insignificant amount of time since,
|
||
|
|
in-lieu of the reported progress, the framework has to assume that an error
|
||
|
|
has occured and time-out the operation.</p>]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.util.Progressable -->
|
||
|
|
<!-- start class org.apache.hadoop.util.ReflectionUtils -->
|
||
|
|
<class name="ReflectionUtils" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="ReflectionUtils"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="setConf"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="theObject" type="java.lang.Object"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Check and set 'configuration' if necessary.
|
||
|
|
|
||
|
|
@param theObject object for which to set configuration
|
||
|
|
@param conf Configuration]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="newInstance" return="T"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="theClass" type="java.lang.Class"/>
|
||
|
|
<param name="conf" type="org.apache.hadoop.conf.Configuration"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create an object for the given class and initialize it from conf
|
||
|
|
|
||
|
|
@param theClass class of which an object is created
|
||
|
|
@param conf Configuration
|
||
|
|
@return a new object]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="setContentionTracing"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="val" type="boolean"/>
|
||
|
|
</method>
|
||
|
|
<method name="printThreadInfo"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="stream" type="java.io.PrintWriter"/>
|
||
|
|
<param name="title" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Print all of the thread's information and stack traces.
|
||
|
|
|
||
|
|
@param stream the stream to
|
||
|
|
@param title a string title for the stack trace]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="logThreadInfo"
|
||
|
|
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="title" type="java.lang.String"/>
|
||
|
|
<param name="minInterval" type="long"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Log the current thread stacks at INFO level.
|
||
|
|
@param log the logger that logs the stack trace
|
||
|
|
@param title a descriptive title for the call stacks
|
||
|
|
@param minInterval the minimum time from the last]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getClass" return="java.lang.Class"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="o" type="T"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Return the correctly-typed {@link Class} of the given object.
|
||
|
|
|
||
|
|
@param o object whose correctly-typed <code>Class</code> is to be obtained
|
||
|
|
@return the correctly typed <code>Class</code> of the given object.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="copy" return="T"
|
||
|
|
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="src" type="T"/>
|
||
|
|
<param name="dst" type="T"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Make a copy of the writable object using serialization to a buffer
|
||
|
|
@param dst the object to copy from
|
||
|
|
@param src the object to copy into, which is destroyed
|
||
|
|
@throws IOException]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="cloneWritableInto"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="dst" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<param name="src" type="org.apache.hadoop.io.Writable"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[General reflection utils]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.ReflectionUtils -->
|
||
|
|
<!-- start class org.apache.hadoop.util.Shell.ExitCodeException -->
|
||
|
|
<class name="Shell.ExitCodeException" extends="java.io.IOException"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="Shell.ExitCodeException" type="int, java.lang.String"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="getExitCode" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This is an IOException with exit code added.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.Shell.ExitCodeException -->
|
||
|
|
<!-- start class org.apache.hadoop.util.Shell.ShellCommandExecutor -->
|
||
|
|
<class name="Shell.ShellCommandExecutor" extends="org.apache.hadoop.util.Shell"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="Shell.ShellCommandExecutor" type="java.lang.String[]"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File, java.util.Map"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<constructor name="Shell.ShellCommandExecutor" type="java.lang.String[], java.io.File, java.util.Map, long"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Create a new instance of the ShellCommandExecutor to execute a command.
|
||
|
|
|
||
|
|
@param execString The command to execute with arguments
|
||
|
|
@param dir If not-null, specifies the directory which should be set
|
||
|
|
as the current working directory for the command.
|
||
|
|
If null, the current working directory is not modified.
|
||
|
|
@param env If not-null, environment of the command will include the
|
||
|
|
key-value pairs specified in the map. If null, the current
|
||
|
|
environment is not modified.
|
||
|
|
@param timeout Specifies the time in milliseconds, after which the
|
||
|
|
command will be killed and the status marked as timedout.
|
||
|
|
If 0, the command will not be timed out.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="execute"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Execute the shell command.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="getExecString" return="java.lang.String[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="parseExecResult"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="protected"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="lines" type="java.io.BufferedReader"/>
|
||
|
|
<exception name="IOException" type="java.io.IOException"/>
|
||
|
|
</method>
|
||
|
|
<method name="getOutput" return="java.lang.String"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Get the output of the shell command.]]>
|
||
|
|
</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 the commands of this instance.
|
||
|
|
Arguments with spaces in are presented with quotes round; other
|
||
|
|
arguments are presented raw
|
||
|
|
|
||
|
|
@return a string representation of the object.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A simple shell command executor.
|
||
|
|
|
||
|
|
<code>ShellCommandExecutor</code>should be used in cases where the output
|
||
|
|
of the command needs no explicit parsing and where the command, working
|
||
|
|
directory and the environment remains unchanged. The output of the command
|
||
|
|
is stored as-is and is expected to be small.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.Shell.ShellCommandExecutor -->
|
||
|
|
<!-- start class org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix -->
|
||
|
|
<class name="StringUtils.TraditionalBinaryPrefix" extends="java.lang.Enum"
|
||
|
|
abstract="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<method name="values" return="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="valueOf" return="org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix"
|
||
|
|
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.util.StringUtils.TraditionalBinaryPrefix"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="symbol" type="char"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return The TraditionalBinaryPrefix object corresponding to the symbol.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="string2long" return="long"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="s" type="java.lang.String"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Convert a string to long.
|
||
|
|
The input string is first be trimmed
|
||
|
|
and then it is parsed with traditional binary prefix.
|
||
|
|
|
||
|
|
For example,
|
||
|
|
"-1230k" will be converted to -1230 * 1024 = -1259520;
|
||
|
|
"891g" will be converted to 891 * 1024^3 = 956703965184;
|
||
|
|
|
||
|
|
@param s input string
|
||
|
|
@return a long value represented by the input string.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<field name="value" type="long"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<field name="symbol" type="char"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[The traditional binary prefixes, kilo, mega, ..., exa,
|
||
|
|
which can be represented by a 64-bit integer.
|
||
|
|
TraditionalBinaryPrefix symbol are case insensitive.]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix -->
|
||
|
|
<!-- start interface org.apache.hadoop.util.Tool -->
|
||
|
|
<interface name="Tool" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.conf.Configurable"/>
|
||
|
|
<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"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Execute the command with the given arguments.
|
||
|
|
|
||
|
|
@param args command specific arguments.
|
||
|
|
@return exit code.
|
||
|
|
@throws Exception]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A tool interface that supports handling of generic command-line options.
|
||
|
|
|
||
|
|
<p><code>Tool</code>, is the standard for any Map-Reduce tool/application.
|
||
|
|
The tool/application should delegate the handling of
|
||
|
|
<a href="{@docRoot}/org/apache/hadoop/util/GenericOptionsParser.html#GenericOptions">
|
||
|
|
standard command-line options</a> to {@link ToolRunner#run(Tool, String[])}
|
||
|
|
and only handle its custom arguments.</p>
|
||
|
|
|
||
|
|
<p>Here is how a typical <code>Tool</code> is implemented:</p>
|
||
|
|
<p><blockquote><pre>
|
||
|
|
public class MyApp extends Configured implements Tool {
|
||
|
|
|
||
|
|
public int run(String[] args) throws Exception {
|
||
|
|
// <code>Configuration</code> processed by <code>ToolRunner</code>
|
||
|
|
Configuration conf = getConf();
|
||
|
|
|
||
|
|
// Create a JobConf using the processed <code>conf</code>
|
||
|
|
JobConf job = new JobConf(conf, MyApp.class);
|
||
|
|
|
||
|
|
// Process custom command-line options
|
||
|
|
Path in = new Path(args[1]);
|
||
|
|
Path out = new Path(args[2]);
|
||
|
|
|
||
|
|
// Specify various job-specific parameters
|
||
|
|
job.setJobName("my-app");
|
||
|
|
job.setInputPath(in);
|
||
|
|
job.setOutputPath(out);
|
||
|
|
job.setMapperClass(MyMapper.class);
|
||
|
|
job.setReducerClass(MyReducer.class);
|
||
|
|
|
||
|
|
// Submit the job, then poll for progress until the job is complete
|
||
|
|
JobClient.runJob(job);
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
public static void main(String[] args) throws Exception {
|
||
|
|
// Let <code>ToolRunner</code> handle generic command-line options
|
||
|
|
int res = ToolRunner.run(new Configuration(), new MyApp(), args);
|
||
|
|
|
||
|
|
System.exit(res);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</pre></blockquote></p>
|
||
|
|
|
||
|
|
@see GenericOptionsParser
|
||
|
|
@see ToolRunner]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.util.Tool -->
|
||
|
|
<!-- start class org.apache.hadoop.util.ToolRunner -->
|
||
|
|
<class name="ToolRunner" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="ToolRunner"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</constructor>
|
||
|
|
<method name="run" return="int"
|
||
|
|
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="tool" type="org.apache.hadoop.util.Tool"/>
|
||
|
|
<param name="args" type="java.lang.String[]"/>
|
||
|
|
<exception name="Exception" type="java.lang.Exception"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Runs the given <code>Tool</code> by {@link Tool#run(String[])}, after
|
||
|
|
parsing with the given generic arguments. Uses the given
|
||
|
|
<code>Configuration</code>, or builds one if null.
|
||
|
|
|
||
|
|
Sets the <code>Tool</code>'s configuration with the possibly modified
|
||
|
|
version of the <code>conf</code>.
|
||
|
|
|
||
|
|
@param conf <code>Configuration</code> for the <code>Tool</code>.
|
||
|
|
@param tool <code>Tool</code> to run.
|
||
|
|
@param args command-line arguments to the tool.
|
||
|
|
@return exit code of the {@link Tool#run(String[])} method.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="run" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="tool" type="org.apache.hadoop.util.Tool"/>
|
||
|
|
<param name="args" type="java.lang.String[]"/>
|
||
|
|
<exception name="Exception" type="java.lang.Exception"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Runs the <code>Tool</code> with its <code>Configuration</code>.
|
||
|
|
|
||
|
|
Equivalent to <code>run(tool.getConf(), tool, args)</code>.
|
||
|
|
|
||
|
|
@param tool <code>Tool</code> to run.
|
||
|
|
@param args command-line arguments to the tool.
|
||
|
|
@return exit code of the {@link Tool#run(String[])} method.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="printGenericCommandUsage"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="true" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="out" type="java.io.PrintStream"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Prints generic command-line argurments and usage information.
|
||
|
|
|
||
|
|
@param out stream to write usage information to.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[A utility to help run {@link Tool}s.
|
||
|
|
|
||
|
|
<p><code>ToolRunner</code> can be used to run classes implementing
|
||
|
|
<code>Tool</code> interface. It works in conjunction with
|
||
|
|
{@link GenericOptionsParser} to parse the
|
||
|
|
<a href="{@docRoot}/org/apache/hadoop/util/GenericOptionsParser.html#GenericOptions">
|
||
|
|
generic hadoop command line arguments</a> and modifies the
|
||
|
|
<code>Configuration</code> of the <code>Tool</code>. The
|
||
|
|
application-specific options are passed along without being modified.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
@see Tool
|
||
|
|
@see GenericOptionsParser]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.ToolRunner -->
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Common utilities.]]>
|
||
|
|
</doc>
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.util.bloom">
|
||
|
|
<!-- start class org.apache.hadoop.util.bloom.BloomFilter -->
|
||
|
|
<class name="BloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="BloomFilter"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default constructor - use with readFields]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="BloomFilter" type="int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
@param vectorSize The vector size of <i>this</i> filter.
|
||
|
|
@param nbHash The number of hash function to consider.
|
||
|
|
@param hashType type of the hashing function (see
|
||
|
|
{@link org.apache.hadoop.util.hash.Hash}).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="add"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="and"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="membershipTest" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="not"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="or"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="xor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</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="getVectorSize" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[@return size of the the bloomfilter]]>
|
||
|
|
</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[Implements a <i>Bloom filter</i>, as defined by Bloom in 1970.
|
||
|
|
<p>
|
||
|
|
The Bloom filter is a data structure that was introduced in 1970 and that has been adopted by
|
||
|
|
the networking research community in the past decade thanks to the bandwidth efficiencies that it
|
||
|
|
offers for the transmission of set membership information between networked hosts. A sender encodes
|
||
|
|
the information into a bit vector, the Bloom filter, that is more compact than a conventional
|
||
|
|
representation. Computation and space costs for construction are linear in the number of elements.
|
||
|
|
The receiver uses the filter to test whether various elements are members of the set. Though the
|
||
|
|
filter will occasionally return a false positive, it will never return a false negative. When creating
|
||
|
|
the filter, the sender can choose its desired point in a trade-off between the false positive rate and the size.
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Originally created by
|
||
|
|
<a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
|
||
|
|
|
||
|
|
@see Filter The general behavior of a filter
|
||
|
|
|
||
|
|
@see <a href="http://portal.acm.org/citation.cfm?id=362692&dl=ACM&coll=portal">Space/Time Trade-Offs in Hash Coding with Allowable Errors</a>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.bloom.BloomFilter -->
|
||
|
|
<!-- start class org.apache.hadoop.util.bloom.CountingBloomFilter -->
|
||
|
|
<class name="CountingBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="CountingBloomFilter"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default constructor - use with readFields]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="CountingBloomFilter" type="int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
@param vectorSize The vector size of <i>this</i> filter.
|
||
|
|
@param nbHash The number of hash function to consider.
|
||
|
|
@param hashType type of the hashing function (see
|
||
|
|
{@link org.apache.hadoop.util.hash.Hash}).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="add"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="delete"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Removes a specified key from <i>this</i> counting Bloom filter.
|
||
|
|
<p>
|
||
|
|
<b>Invariant</b>: nothing happens if the specified key does not belong to <i>this</i> counter Bloom filter.
|
||
|
|
@param key The key to remove.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="and"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="membershipTest" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="approximateCount" return="int"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[This method calculates an approximate count of the key, i.e. how many
|
||
|
|
times the key was added to the filter. This allows the filter to be
|
||
|
|
used as an approximate <code>key -> count</code> map.
|
||
|
|
<p>NOTE: due to the bucket size of this filter, inserting the same
|
||
|
|
key more than 15 times will cause an overflow at all filter positions
|
||
|
|
associated with this key, and it will significantly increase the error
|
||
|
|
rate for this and other keys. For this reason the filter can only be
|
||
|
|
used to store small count values <code>0 <= N << 15</code>.
|
||
|
|
@param key key to be tested
|
||
|
|
@return 0 if the key is not present. Otherwise, a positive value v will
|
||
|
|
be returned such that <code>v == count</code> with probability equal to the
|
||
|
|
error rate of this filter, and <code>v > count</code> otherwise.
|
||
|
|
Additionally, if the filter experienced an underflow as a result of
|
||
|
|
{@link #delete(Key)} operation, the return value may be lower than the
|
||
|
|
<code>count</code> with the probability of the false negative rate of such
|
||
|
|
filter.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="not"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="or"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="xor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</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="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[Implements a <i>counting Bloom filter</i>, as defined by Fan et al. in a ToN
|
||
|
|
2000 paper.
|
||
|
|
<p>
|
||
|
|
A counting Bloom filter is an improvement to standard a Bloom filter as it
|
||
|
|
allows dynamic additions and deletions of set membership information. This
|
||
|
|
is achieved through the use of a counting vector instead of a bit vector.
|
||
|
|
<p>
|
||
|
|
Originally created by
|
||
|
|
<a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
|
||
|
|
|
||
|
|
@see Filter The general behavior of a filter
|
||
|
|
|
||
|
|
@see <a href="http://portal.acm.org/citation.cfm?id=343571.343572">Summary cache: a scalable wide-area web cache sharing protocol</a>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.bloom.CountingBloomFilter -->
|
||
|
|
<!-- start class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
|
||
|
|
<class name="DynamicBloomFilter" extends="org.apache.hadoop.util.bloom.Filter"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="DynamicBloomFilter"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Zero-args constructor for the serialization.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="DynamicBloomFilter" type="int, int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor.
|
||
|
|
<p>
|
||
|
|
Builds an empty Dynamic Bloom filter.
|
||
|
|
@param vectorSize The number of bits in the vector.
|
||
|
|
@param nbHash The number of hash function to consider.
|
||
|
|
@param hashType type of the hashing function (see
|
||
|
|
{@link org.apache.hadoop.util.hash.Hash}).
|
||
|
|
@param nr The threshold for the maximum number of keys to record in a
|
||
|
|
dynamic Bloom filter row.]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="add"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="and"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="membershipTest" return="boolean"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="not"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
</method>
|
||
|
|
<method name="or"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</method>
|
||
|
|
<method name="xor"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="filter" type="org.apache.hadoop.util.bloom.Filter"/>
|
||
|
|
</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="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[Implements a <i>dynamic Bloom filter</i>, as defined in the INFOCOM 2006 paper.
|
||
|
|
<p>
|
||
|
|
A dynamic Bloom filter (DBF) makes use of a <code>s * m</code> bit matrix but
|
||
|
|
each of the <code>s</code> rows is a standard Bloom filter. The creation
|
||
|
|
process of a DBF is iterative. At the start, the DBF is a <code>1 * m</code>
|
||
|
|
bit matrix, i.e., it is composed of a single standard Bloom filter.
|
||
|
|
It assumes that <code>n<sub>r</sub></code> elements are recorded in the
|
||
|
|
initial bit vector, where <code>n<sub>r</sub> <= n</code> (<code>n</code> is
|
||
|
|
the cardinality of the set <code>A</code> to record in the filter).
|
||
|
|
<p>
|
||
|
|
As the size of <code>A</code> grows during the execution of the application,
|
||
|
|
several keys must be inserted in the DBF. When inserting a key into the DBF,
|
||
|
|
one must first get an active Bloom filter in the matrix. A Bloom filter is
|
||
|
|
active when the number of recorded keys, <code>n<sub>r</sub></code>, is
|
||
|
|
strictly less than the current cardinality of <code>A</code>, <code>n</code>.
|
||
|
|
If an active Bloom filter is found, the key is inserted and
|
||
|
|
<code>n<sub>r</sub></code> is incremented by one. On the other hand, if there
|
||
|
|
is no active Bloom filter, a new one is created (i.e., a new row is added to
|
||
|
|
the matrix) according to the current size of <code>A</code> and the element
|
||
|
|
is added in this new Bloom filter and the <code>n<sub>r</sub></code> value of
|
||
|
|
this new Bloom filter is set to one. A given key is said to belong to the
|
||
|
|
DBF if the <code>k</code> positions are set to one in one of the matrix rows.
|
||
|
|
<p>
|
||
|
|
Originally created by
|
||
|
|
<a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
|
||
|
|
|
||
|
|
@see Filter The general behavior of a filter
|
||
|
|
@see BloomFilter A Bloom filter
|
||
|
|
|
||
|
|
@see <a href="http://www.cse.fau.edu/~jie/research/publications/Publication_files/infocom2006.pdf">Theory and Network Applications of Dynamic Bloom Filters</a>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.bloom.DynamicBloomFilter -->
|
||
|
|
<!-- start class org.apache.hadoop.util.bloom.HashFunction -->
|
||
|
|
<class name="HashFunction" extends="java.lang.Object"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<constructor name="HashFunction" type="int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor.
|
||
|
|
<p>
|
||
|
|
Builds a hash function that must obey to a given maximum number of returned values and a highest value.
|
||
|
|
@param maxValue The maximum highest returned value.
|
||
|
|
@param nbHash The number of resulting hashed values.
|
||
|
|
@param hashType type of the hashing function (see {@link Hash}).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="clear"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Clears <i>this</i> hash function. A NOOP]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="hash" return="int[]"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="k" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Hashes a specified key into several integers.
|
||
|
|
@param k The specified key.
|
||
|
|
@return The array of hashed values.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Implements a hash object that returns a certain number of hashed values.
|
||
|
|
|
||
|
|
@see Key The general behavior of a key being stored in a filter
|
||
|
|
@see Filter The general behavior of a filter]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.bloom.HashFunction -->
|
||
|
|
<!-- start interface org.apache.hadoop.util.bloom.RemoveScheme -->
|
||
|
|
<interface name="RemoveScheme" abstract="true"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<field name="RANDOM" type="short"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Random selection.
|
||
|
|
<p>
|
||
|
|
The idea is to randomly select a bit to reset.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="MINIMUM_FN" type="short"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[MinimumFN Selection.
|
||
|
|
<p>
|
||
|
|
The idea is to select the bit to reset that will generate the minimum
|
||
|
|
number of false negative.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="MAXIMUM_FP" type="short"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[MaximumFP Selection.
|
||
|
|
<p>
|
||
|
|
The idea is to select the bit to reset that will remove the maximum number
|
||
|
|
of false positive.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<field name="RATIO" type="short"
|
||
|
|
transient="false" volatile="false"
|
||
|
|
static="true" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Ratio Selection.
|
||
|
|
<p>
|
||
|
|
The idea is to select the bit to reset that will, at the same time, remove
|
||
|
|
the maximum number of false positve while minimizing the amount of false
|
||
|
|
negative generated.]]>
|
||
|
|
</doc>
|
||
|
|
</field>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Defines the different remove scheme for retouched Bloom filters.
|
||
|
|
<p>
|
||
|
|
Originally created by
|
||
|
|
<a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.]]>
|
||
|
|
</doc>
|
||
|
|
</interface>
|
||
|
|
<!-- end interface org.apache.hadoop.util.bloom.RemoveScheme -->
|
||
|
|
<!-- start class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
|
||
|
|
<class name="RetouchedBloomFilter" extends="org.apache.hadoop.util.bloom.BloomFilter"
|
||
|
|
abstract="false"
|
||
|
|
static="false" final="true" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<implements name="org.apache.hadoop.util.bloom.RemoveScheme"/>
|
||
|
|
<constructor name="RetouchedBloomFilter"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Default constructor - use with readFields]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<constructor name="RetouchedBloomFilter" type="int, int, int"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Constructor
|
||
|
|
@param vectorSize The vector size of <i>this</i> filter.
|
||
|
|
@param nbHash The number of hash function to consider.
|
||
|
|
@param hashType type of the hashing function (see
|
||
|
|
{@link org.apache.hadoop.util.hash.Hash}).]]>
|
||
|
|
</doc>
|
||
|
|
</constructor>
|
||
|
|
<method name="add"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
</method>
|
||
|
|
<method name="addFalsePositive"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="key" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds a false positive information to <i>this</i> retouched Bloom filter.
|
||
|
|
<p>
|
||
|
|
<b>Invariant</b>: if the false positive is <code>null</code>, nothing happens.
|
||
|
|
@param key The false positive key to add.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addFalsePositive"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="coll" type="java.util.Collection"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds a collection of false positive information to <i>this</i> retouched Bloom filter.
|
||
|
|
@param coll The collection of false positive.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addFalsePositive"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="keys" type="java.util.List"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds a list of false positive information to <i>this</i> retouched Bloom filter.
|
||
|
|
@param keys The list of false positive.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="addFalsePositive"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="keys" type="org.apache.hadoop.util.bloom.Key[]"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Adds an array of false positive information to <i>this</i> retouched Bloom filter.
|
||
|
|
@param keys The array of false positive.]]>
|
||
|
|
</doc>
|
||
|
|
</method>
|
||
|
|
<method name="selectiveClearing"
|
||
|
|
abstract="false" native="false" synchronized="false"
|
||
|
|
static="false" final="false" visibility="public"
|
||
|
|
deprecated="not deprecated">
|
||
|
|
<param name="k" type="org.apache.hadoop.util.bloom.Key"/>
|
||
|
|
<param name="scheme" type="short"/>
|
||
|
|
<doc>
|
||
|
|
<![CDATA[Performs the selective clearing for a given key.
|
||
|
|
@param k The false positive key to remove from <i>this</i> retouched Bloom filter.
|
||
|
|
@param scheme The selective clearing scheme to apply.]]>
|
||
|
|
</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[Implements a <i>retouched Bloom filter</i>, as defined in the CoNEXT 2006 paper.
|
||
|
|
<p>
|
||
|
|
It allows the removal of selected false positives at the cost of introducing
|
||
|
|
random false negatives, and with the benefit of eliminating some random false
|
||
|
|
positives at the same time.
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Originally created by
|
||
|
|
<a href="http://www.one-lab.org">European Commission One-Lab Project 034819</a>.
|
||
|
|
|
||
|
|
@see Filter The general behavior of a filter
|
||
|
|
@see BloomFilter A Bloom filter
|
||
|
|
@see RemoveScheme The different selective clearing algorithms
|
||
|
|
|
||
|
|
@see <a href="http://www-rp.lip6.fr/site_npa/site_rp/_publications/740-rbf_cameraready.pdf">Retouched Bloom Filters: Allowing Networked Applications to Trade Off Selected False Positives Against False Negatives</a>]]>
|
||
|
|
</doc>
|
||
|
|
</class>
|
||
|
|
<!-- end class org.apache.hadoop.util.bloom.RetouchedBloomFilter -->
|
||
|
|
</package>
|
||
|
|
<package name="org.apache.hadoop.util.hash">
|
||
|
|
</package>
|
||
|
|
|
||
|
|
</api>
|