poojaruhal/Code-comment-classification

1stratum,class,comment,summary,Expand,rational,deprecation,usage,exception,todo,Incomplete,Commentedcode,directive,formatter,License,Ownership,Pointer,Autogenerated,Noise,Warning,Recommendation,Precondition,CodingGuidelines,Extension,Subclassexplnation,Observation21,Abfss.java,"* Azure Blob File System implementation of AbstractFileSystem.3* This impl delegates to the old FileSystem",Azure Blob File System implementation of AbstractFileSystem.,This impl delegates to the old FileSystem,,,,,,,,,,,,,,,,,,,,,41,AbstractContractGetFileStatusTest.java,"* Test getFileStatus and related listing operations.5| the tree parameters. Kept small to avoid killing object store test| runs too much.|6* Accept everything.7| the tree parameters. Kept small to avoid killing object store test| runs too much.|8* Accept nothing.9| the tree parameters. Kept small to avoid killing object store test| runs too much.|10* Path filter which only expects paths whose final name element11* equals the {@code match} field.12| the tree parameters. Kept small to avoid killing object store test| runs too much.|13* A filesystem filter which exposes the protected method14* {@link #listLocatedStatus(Path, PathFilter)}.",Test getFileStatus and related listing operations.,"| the tree parameters. Kept small to avoid killing object store test| runs too much.|15* Accept everything.16| the tree parameters. Kept small to avoid killing object store test| runs too much.|17* Accept nothing.18| the tree parameters. Kept small to avoid killing object store test| runs too much.|19* Path filter which only expects paths whose final name element20* equals the {@code match} field.21| the tree parameters. Kept small to avoid killing object store test| runs too much.|22* A filesystem filter which exposes the protected method23* {@link #listLocatedStatus(Path, PathFilter)}.",,,,,,,,,,,,,,,,,,,,,241,AbstractFSContract.java,"* Class representing a filesystem contract that a filesystem25* implementation is expected implement.26*27* Part of this contract class is to allow FS implementations to28* provide specific opt outs and limits, so that tests can be29* skip unsupported features (e.g. case sensitivity tests),30* dangerous operations (e.g. trying to delete the root directory),31* and limit filesize and other numeric variables for scale tests",Class representing a filesystem contract that a filesystem * implementation is expected implement.,,"Part of this contract class is to allow FS implementations to * provide specific opt outs and limits, so that tests can be * skip unsupported features (e.g. case sensitivity tests), * dangerous operations (e.g. trying to delete the root directory), * and limit filesize and other numeric variables for scale tests",,,,,,,,,,,,,,,,,,,,321,AbstractS3ACommitterFactory.java,* Dynamically create the output committer based on subclass type and settings.,,Dynamically create the output committer based on subclass type and settings.,,,,,,,,,,,,,,,,,,,,,331,AbstractTFLaunchCommandTestHelper.java,"* This class is an abstract base class for testing Tensorboard and TensorFlow34* launch commands.",This class is an abstract base class for testing Tensorboard and TensorFlow and launch commands.,,This class is an abstract base class for testing Tensorboard and TensorFlow and launch commands.,,,,,,,,,,,,,,,,,,,,351,ApplicationConstants.java,"* This is the API for the applications comprising of constants that YARN sets36* up for the applications and the containers.37*38* TODO: Investigate the semantics and security of each cross-boundary refs.39|40* The type of launch for the container.41|42* Environment for Applications.43*44* Some of the environment variables for applications are <em>final</em>45* i.e. they cannot be modified by the applications.",* This is the API for the applications comprising of constants that YARN sets * up for the applications and the containers.,The type of launch for the container. | * Environment for Applications. * * Some of the environment variables for applications are <em>final</em> * i.e. they cannot be modified by the applications.,,,,,TODO: Investigate the semantics and security of each cross-boundary refs.,,,,,,,,,,"* Some of the environment variables for applications are <em>final</em>46* i.e. they cannot be modified by the applications.",,,,,,471,ApplicationStateData.java,* Contains all the state data that needs to be stored persistently * for an Application,Contains all the state data that needs to be stored persistently * for an Application,,needs to be stored persistently * for an Application,,,,,,,,,,,,,,,,,,,,481,AutoInputFormat.java,"* An {@link InputFormat} that tries to deduce the types of the input files49* automatically. It can currently handle text and sequence files.",An {@link InputFormat} that tries to deduce the types of the input files * automatically.,It can currently handle text and sequence files.,,,,,,,,,,,,An {@link InputFormat} that tries to deduce the types of the input files * automatically.,,,,,,,,,501,BalancingPolicy.java,"* Balancing policy.51* Since a datanode may contain multiple block pools,52* {@link Pool} implies {@link Node}53* but NOT the other way around54|55* Cluster is balanced if each node is balanced.56|57* Cluster is balanced if each pool in each node is balanced.",* Balancing policy.,"Since a datanode may contain multiple block pools, * {@link Pool} implies {@link Node} * but NOT the other way around |",Cluster is balanced if each node is balanced. | * Cluster is balanced if each pool in each node is balanced.,,,,,,,,,,,"Since a datanode may contain multiple block pools, * {@link Pool} implies {@link Node} * but NOT the other way around |",,,,,,,,,581,BaseRouterWebServicesTest.java,"* Base class for all the RouterRMAdminService test cases. It provides utility59* methods that can be used by the concrete test case classes.60*",* Base class for all the RouterRMAdminService test cases.,,,,It provides utility * methods that can be used by the concrete test case classes.,,,,,,,,,,,,,,,,,,611,BatchedRequests.java,"* A grouping of Scheduling Requests which are sent to the PlacementAlgorithm62* to place as a batch. The placement algorithm tends to give more optimal63* placements if more requests are batched together.64| PlacementAlgorithmOutput attempt - the number of times the requests in this|65* Iterator Type.","A grouping of Scheduling Requests which are sent to the PlacementAlgorithm66* to place as a batch67Iterator Type.","The placement algorithm tends to give more optimal68* placements if more requests are batched together.",,,| PlacementAlgorithmOutput attempt - the number of times the requests in this|,,,,,,,,,,,,,,,,,,691,BlockPlacementStatusWithNodeGroup.java,"* An implementation of @see BlockPlacementStatus for70* @see BlockPlacementPolicyWithNodeGroup",An implementation of @see BlockPlacementStatus,,for * @see BlockPlacementPolicyWithNodeGroup,,,,,,,,,,,for * @see BlockPlacementPolicyWithNodeGroup,,,,,,,,,711,BlocksMap.java,"* This class maintains the map from a block to its metadata.72* block's metadata currently includes blockCollection it belongs to and73* the datanodes that store the block.",This class maintains the map from a block to its metadata.,"block's metadata currently includes blockCollection it belongs to and74* the datanodes that store the block.",,,,,,,,,,,,,,,,,,,,,751,BlockUtils.java,* Utils functions to help block functions.,Utils functions to help block functions,,Utils functions to help block functions,,,,,,,,,,,,,,,,,,,,761,ByteArrayEncodingState.java,"* A utility class that maintains encoding state during an encode call using77* byte array inputs.",A utility class that maintains encoding state during an encode call using * byte array inputs.,A utility class that maintains encoding state during an encode call using * byte array inputs.,,,,,,,,,,,,,,,,,,,,,781,CapacitySchedulerPlanFollower.java,"* This class implements a {@link PlanFollower}. This is invoked on a timer, and79* it is in charge to publish the state of the {@link Plan}s to the underlying80* {@link CapacityScheduler}. This implementation does so, by81* adding/removing/resizing leaf queues in the scheduler, thus affecting the82* dynamic behavior of the scheduler in a way that is consistent with the83* content of the plan. It also updates the plan's view on how much resources84* are available in the cluster.85* * This implementation of PlanFollower is relatively stateless, and it can86* synchronize schedulers and Plans that have arbitrary changes (performing set87* differences among existing queues). This makes it resilient to frequency of88* synchronization, and RM restart issues (no ""catch up"" is necessary).","This class implements a {@link PlanFollower}. This is invoked on a timer, and89* it is in charge to publish the state of the {@link Plan}s to the underlying90* {@link CapacityScheduler}.","This implementation does so, by91* adding/removing/resizing leaf queues in the scheduler, thus affecting the92* dynamic behavior of the scheduler in a way that is consistent with the93* content of the plan. It also updates the plan's view on how much resources94* are available in the cluster.","This implementation of PlanFollower is relatively stateless, and it can95* synchronize schedulers and Plans that have arbitrary changes (performing set96* differences among existing queues). This makes it resilient to frequency of97* synchronization, and RM restart issues (no ""catch up"" is necessary).",,,,,,,,,,,,,,,,,,,,981,Classpath.java,"* Command-line utility for getting the full classpath needed to launch a Hadoop99* client application. If the hadoop script is called with ""classpath"" as the100* command, then it simply prints the classpath and exits immediately without101* launching a JVM. The output likely will include wildcards in the classpath.102* If there are arguments passed to the classpath command, then this class gets103* called. With the --glob argument, it prints the full classpath with wildcards104* expanded. This is useful in situations where wildcard syntax isn't usable.105* With the --jar argument, it writes the classpath as a manifest in a jar file.106* This is useful in environments with short limitations on the maximum command107* line length, where it may not be possible to specify the full classpath in a108* command. For example, the maximum command line length on Windows is 8191109* characters.",Command-line utility for getting the full classpath needed to launch a Hadoop * client application.,"If the hadoop script is called with ""classpath"" as the * command, then it simply prints the classpath and exits immediately without * launching a JVM. The output likely will include wildcards in the classpath. * If there are arguments passed to the classpath command, then this class gets * called. With the --glob argument, it prints the full classpath with wildcards * expanded. This is useful in situations where wildcard syntax isn't usable. * With the --jar argument, it writes the classpath as a manifest in a jar file. * This is useful in environments with short limitations on the maximum command * line length, where it may not be possible to specify the full classpath in a * command. For example, the maximum command line length on Windows is 8191 * characters.",,,,,,,,,,,,,,,,,,,,,1101,ComparableVersion.java,"Code source of this file:| http://grepcode.com/file/repo1.maven.org/maven2/| org.apache.maven/maven-artifact/3.1.1/| org/apache/maven/artifact/versioning/ComparableVersion.java/|| Modifications made on top of the source:| 1. Changed| package org.apache.maven.artifact.versioning;| to| package org.apache.hadoop.util;| 2. Removed author tags to clear hadoop author tag warning|111* Generic implementation of version comparison.112* * <p>Features:113* <ul>114* <li>mixing of '<code>-</code>' (dash) and '<code>.</code>' (dot) separators,</li>115* <li>transition between characters and digits also constitutes a separator:116* <code>1.0alpha1 =&gt; [1, 0, alpha, 1]</code></li>117* <li>unlimited number of version components,</li>118* <li>version components in the text can be digits or strings,</li>119* <li>strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering.120* Well-known qualifiers (case insensitive) are:<ul>121* <li><code>alpha</code> or <code>a</code></li>122* <li><code>beta</code> or <code>b</code></li>123* <li><code>milestone</code> or <code>m</code></li>124* <li><code>rc</code> or <code>cr</code></li>125* <li><code>snapshot</code></li>126* <li><code>(the empty string)</code> or <code>ga</code> or <code>final</code></li>127* <li><code>sp</code></li>128* </ul>129* Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),130* </li>131* <li>a dash usually precedes a qualifier, and is always less important than something preceded with a dot.</li>132* </ul><p>133*134* @see <a href=""https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning"">""Versioning"" on Maven Wiki</a>135|136* Represents a numeric item in the version item list.137|138* Represents a string in the version item list, usually a qualifier.139|140* Represents a version list item. This class is used both for the global item list and for sub-lists (which start141* with '-(number)' in the version specification).","Generic implementation of version comparison. Represents a numeric item in the version item list.142|143* Represents a string in the version item list, usually a qualifier.144|145* Represents a version list item. This class is used both for the global item list and for sub-lists (which start146* with '-(number)' in the version specification).",,,,"* Generic implementation of version comparison.147* * <p>Features:148* <ul>149* <li>mixing of '<code>-</code>' (dash) and '<code>.</code>' (dot) separators,</li>150* <li>transition between characters and digits also constitutes a separator:151* <code>1.0alpha1 =&gt; [1, 0, alpha, 1]</code></li>152* <li>unlimited number of version components,</li>153* <li>version components in the text can be digits or strings,</li>154* <li>strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering.155* Well-known qualifiers (case insensitive) are:<ul>156* <li><code>alpha</code> or <code>a</code></li>157* <li><code>beta</code> or <code>b</code></li>158* <li><code>milestone</code> or <code>m</code></li>159* <li><code>rc</code> or <code>cr</code></li>160* <li><code>snapshot</code></li>161* <li><code>(the empty string)</code> or <code>ga</code> or <code>final</code></li>162* <li><code>sp</code></li>163* </ul>164* Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),165* </li>166* <li>a dash usually precedes a qualifier, and is always less important than something preceded with a dot.</li>167* </ul><p>",,,,,,,,,"Code source of this file:| http://grepcode.com/file/repo1.maven.org/maven2/| org.apache.maven/maven-artifact/3.1.1/| org/apache/maven/artifact/versioning/ComparableVersion.java/|| Modifications made on top of the source:| 1. Changed| package org.apache.maven.artifact.versioning;| to| package org.apache.hadoop.util;| 2. Removed author tags to clear hadoop author tag warning|. * @see <a href=""https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning"">""Versioning"" on Maven Wiki</a>",,,,,,,,,1681,ConfigurationException.java,* Exception to throw in case of a configuration problem.,Exception to throw in case of a configuration problem.,,,,,,,,,,,,,,,,,,,,,,1691,ContainerFinishData.java,"* The class contains the fields that can be determined when170* <code>RMContainer</code> finishes, and that need to be stored persistently.","The class contains the fields that can be determined when * <code>RMContainer</code> finishes, and that need to be stored persistently.",,"The class contains the fields that can be determined when * <code>RMContainer</code> finishes, and that need to be stored persistently.",,,,,,,,,,,,,,,,,,,,1711,CpuTimeTracker.java,* Utility for sampling and computing CPU usage.,Utility for sampling and computing CPU usage,,Utility for sampling and computing CPU usage,,,,,,,,,,,,,,,,,,,,1721,DBProfile.java,"* User visible configs based RocksDB tuning page. Documentation for Options.173* <p>174* https://github.com/facebook/rocksdb/blob/master/include/rocksdb/options.h175* <p>176* Most tuning parameters are based on this URL.177* <p>178* https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning",* User visible configs based RocksDB tuning page.,,,,"Documentation for Options.179* <p>180* https://github.com/facebook/rocksdb/blob/master/include/rocksdb/options.h181* <p>182* Most tuning parameters are based on this URL.183* <p>184* https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning",,,,,,,,,"Documentation for Options.185* <p>186* https://github.com/facebook/rocksdb/blob/master/include/rocksdb/options.h187* <p>188* Most tuning parameters are based on this URL.189* <p>190* https://github.com/facebook/rocksdb/wiki/Setup-Options-and-Basic-Tuning",,,,,,,,,1911,DefaultAnonymizingRumenSerializer.java,* Default Rumen JSON serializer.,Default Rumen JSON serializer.,,,,,,,,,,,,,,,,,,,,,,1921,DelegatingSSLSocketFactory.java,"* A {@link SSLSocketFactory} that can delegate to various SSL implementations.193* Specifically, either OpenSSL or JSSE can be used. OpenSSL offers better194* performance than JSSE and is made available via the195* <a href=""https://github.com/wildfly/wildfly-openssl"">wildlfy-openssl</a>196* library.197*198* <p>199* The factory has several different modes of operation:200* <ul>201* <li>OpenSSL: Uses the wildly-openssl library to delegate to the202* system installed OpenSSL. If the wildfly-openssl integration is not203* properly setup, an exception is thrown.</li>204* <li>Default: Attempts to use the OpenSSL mode, if it cannot load the205* necessary libraries, it falls back to the Default_JSEE mode.</li>206* <li>Default_JSSE: Delegates to the JSSE implementation of SSL, but207* it disables the GCM cipher when running on Java 8.</li>208* <li>Default_JSSE_with_GCM: Delegates to the JSSE implementation of209* SSL with no modification to the list of enabled ciphers.</li>210* </ul>211* </p>212| This should only be modified within the #initializeDefaultFactory|213* Default indicates Ordered, preferred OpenSSL, if failed to load then fall214* back to Default_JSSE.215*216* <p>217* Default_JSSE is not truly the the default JSSE implementation because218* the GCM cipher is disabled when running on Java 8. However, the name219* was not changed in order to preserve backwards compatibility. Instead,220* a new mode called Default_JSSE_with_GCM delegates to the default JSSE221* implementation with no changes to the list of enabled ciphers.222* </p>",* A {@link SSLSocketFactory} that can delegate to various SSL implementations.,"Specifically, either OpenSSL or JSSE can be used. OpenSSL offers better223* performance than JSSE and is made available via the224* <a href=""https://github.com/wildfly/wildfly-openssl"">wildlfy-openssl</a>225* library.","<p>226* Default_JSSE is not truly the the default JSSE implementation because227* the GCM cipher is disabled when running on Java 8. However, the name228* was not changed in order to preserve backwards compatibility. Instead,229* a new mode called Default_JSSE_with_GCM delegates to the default JSSE230* implementation with no changes to the list of enabled ciphers.231* </p>",,"* <p>232* The factory has several different modes of operation:233* <ul>234* <li>OpenSSL: Uses the wildly-openssl library to delegate to the235* system installed OpenSSL. If the wildfly-openssl integration is not236* properly setup, an exception is thrown.</li>237* <li>Default: Attempts to use the OpenSSL mode, if it cannot load the238* necessary libraries, it falls back to the Default_JSEE mode.</li>239* <li>Default_JSSE: Delegates to the JSSE implementation of SSL, but240* it disables the GCM cipher when running on Java 8.</li>241* <li>Default_JSSE_with_GCM: Delegates to the JSSE implementation of242* SSL with no modification to the list of enabled ciphers.</li>243* </ul>244* </p>245| This should only be modified within the #initializeDefaultFactory|246* Default indicates Ordered, preferred OpenSSL, if failed to load then fall247* back to Default_JSSE.",,,,,,,,,"* A {@link SSLSocketFactory} that can delegate to various SSL implementations.248OpenSSL offers better249* performance than JSSE and is made available via the250* <a href=""https://github.com/wildfly/wildfly-openssl"">wildlfy-openssl</a>251* library.",,,| This should only be modified within the #initializeDefaultFactory|,,,,,,2521,DelegationTokenIdentifier.java,* A delegation token identifier that is specific to HDFS.,A delegation token identifier that is specific to HDFS.,A delegation token identifier that is specific to HDFS.,,,,,,,,,,,,,,,,,,,,,2531,DeleteApplicationHomeSubClusterRequest.java,"* The request to <code>Federation state store</code> to delete the mapping of254* home subcluster of a submitted application.",The request to <code>Federation state store</code> to delete the mapping of * home subcluster of a submitted application.,,,,,,,,,,,,,,,,,,,,,,2551,DFSConfigKeys.java,"* This class contains constants for configuration keys and default values256* used in hdfs.",This class contains constants for configuration keys and default values used in hdfs.,,This class contains constants for configuration keys and default values used in hdfs.,,,,,,,,,,,,,,,,,,,,2571,DfsServlet.java,* A base class for the servlets in DFS.,A base class for the servlets in DFS,,,,,,,,,,,,,,,,,,,,,,2581,DiskBalancerCluster.java,"* DiskBalancerCluster represents the nodes that we are working against.259* <p>260* Please Note :261* Semantics of inclusionList and exclusionLists.262* <p>263* If a non-empty inclusionList is specified then the diskBalancer assumes that264* the user is only interested in processing that list of nodes. This node list265* is checked against the exclusionList and only the nodes in inclusionList but266* not in exclusionList is processed.267* <p>268* if inclusionList is empty, then we assume that all live nodes in the nodes is269* to be processed by diskBalancer. In that case diskBalancer will avoid any270* nodes specified in the exclusionList but will process all nodes in the271* cluster.272* <p>273* In other words, an empty inclusionList is means all the nodes otherwise274* only a given list is processed and ExclusionList is always honored.",DiskBalancerCluster represents the nodes that we are working against.,"Please Note :275* Semantics of inclusionList and exclusionLists.276* <p>277* If a non-empty inclusionList is specified then the diskBalancer assumes that278* the user is only interested in processing that list of nodes. This node list279* is checked against the exclusionList and only the nodes in inclusionList but280* not in exclusionList is processed.281* <p>282* if inclusionList is empty, then we assume that all live nodes in the nodes is283* to be processed by diskBalancer. In that case diskBalancer will avoid any284* nodes specified in the exclusionList but will process all nodes in the285* cluster.286* <p>287* In other words, an empty inclusionList is means all the nodes otherwise288* only a given list is processed and ExclusionList is always honored.",,,,,,,,,,,,,,,,,,,,,2891,DistributedSchedulingAllocateRequest.java,"* Object used by the Application Master when distributed scheduling is enabled,290* in order to forward the {@link AllocateRequest} for GUARANTEED containers to291* the Resource Manager, and to notify the Resource Manager about the allocation292* of OPPORTUNISTIC containers through the Distributed Scheduler.","* Object used by the Application Master when distributed scheduling is enabled,","in order to forward the {@link AllocateRequest} for GUARANTEED containers to * the Resource Manager, and to notify the Resource Manager about the allocation * of OPPORTUNISTIC containers through the Distributed Scheduler.",,,,,,,,,,,,"in order to forward the {@link AllocateRequest} for GUARANTEED containers to * the Resource Manager, and to notify the Resource Manager about the allocation * of OPPORTUNISTIC containers through the Distributed Scheduler.",,,,,,,,,2931,DockerKillCommand.java,* Encapsulates the docker kill command and its command line arguments.,Encapsulates the docker kill command and its command line arguments.,,,,,,,,,,,,,,,,,,,,,,2941,EditLogTailer.java,"* EditLogTailer represents a thread which periodically reads from edits295* journals and applies the transactions contained within to a given296* FSNamesystem.297|298* The thread which does the actual work of tailing edits journals and299* applying the transactions to the FSNS.300|301* Manage the 'active namenode proxy'. This cannot just be the a single proxy since we could302* failover across a number of NameNodes, rather than just between an active and a standby.303* <p>304* We - lazily - get a proxy to one of the configured namenodes and attempt to make the request305* against it. If it doesn't succeed, either because the proxy failed to be created or the request306* failed, we try the next NN in the list. We try this up to the configuration maximum number of307* retries before throwing up our hands. A working proxy is retained across attempts since we308* expect the active NameNode to switch rarely.309* <p>310* This mechanism is <b>very bad</b> for cases where we care about being <i>fast</i>; it just311* blindly goes and tries namenodes.","EditLogTailer represents a thread which periodically reads from edits312* journals and applies the transactions contained within to a given313* FSNamesystem.","|314* The thread which does the actual work of tailing edits journals and315* applying the transactions to the FSNS.316|","* Manage the 'active namenode proxy'. This cannot just be the a single proxy since we could317* failover across a number of NameNodes, rather than just between an active and a standby.318* <p>319* We - lazily - get a proxy to one of the configured namenodes and attempt to make the request320* against it. If it doesn't succeed, either because the proxy failed to be created or the request321* failed, we try the next NN in the list. We try this up to the configuration maximum number of322* retries before throwing up our hands. A working proxy is retained across attempts since we323* expect the active NameNode to switch rarely.324* <p>325* This mechanism is <b>very bad</b> for cases where we care about being <i>fast</i>; it just326* blindly goes and tries namenodes.",,,,,,,,,,,,,,,,,,,,3271,ErasureCodingPolicyManager.java,"* This manages erasure coding policies predefined and activated in the system.328* It loads customized policies and syncs with persisted ones in329* NameNode image.330*331* This class is instantiated by the FSNamesystem.",This manages erasure coding policies predefined and activated in the system,"It loads customized policies and syncs with persisted ones in332* NameNode image.",,,This class is instantiated by the FSNamesystem.,,,,,,,,,* This class is instantiated by the FSNamesystem.,,,,,,,,,3331,EventWatcher.java,"* Event watcher the (re)send a message after timeout.334* <p>335* Event watcher will send the tracked payload/event after a timeout period336* unless a confirmation from the original event (completion event) is arrived.337*338* @param <TIMEOUT_PAYLOAD> The type of the events which are tracked.339* @param <COMPLETION_PAYLOAD> The type of event which could cancel the340* tracking.",* Event watcher the (re)send a message after timeout.,,"Event watcher will send the tracked payload/event after a timeout period341* unless a confirmation from the original event (completion event) is arrived.",,,,,,,,,,,"* @param <TIMEOUT_PAYLOAD> The type of the events which are tracked.342* @param <COMPLETION_PAYLOAD> The type of event which could cancel the343* tracking.",,,,,,,,,3441,Expression.java,"* Interface describing an expression to be used in the345* {@link org.apache.hadoop.fs.shell.find.Find} command.",Interface describing an expression to be used in the * {@link org.apache.hadoop.fs.shell.find.Find} command.,,to be used in the * {@link org.apache.hadoop.fs.shell.find.Find} command.,,,,,,,,,,,to be used in the * {@link org.apache.hadoop.fs.shell.find.Find} command.,,,,,,,,,3461,FairOrderingPolicy.java,"* An OrderingPolicy which orders SchedulableEntities for fairness (see347* FairScheduler348* FairSharePolicy), generally, processes with lesser usage are lesser. If349* sizedBasedWeight is set to true then an application with high demand350* may be prioritized ahead of an application with less usage. This351* is to offset the tendency to favor small apps, which could result in352* starvation for large apps if many small ones enter and leave the queue353* continuously (optional, default false)","* An OrderingPolicy which orders SchedulableEntities for fairness (see354* FairScheduler355* FairSharePolicy), generally, processes with lesser usage are lesser",,,,"If356* sizedBasedWeight is set to true then an application with high demand357* may be prioritized ahead of an application with less usage. This358* is to offset the tendency to favor small apps, which could result in359* starvation for large apps if many small ones enter and leave the queue360* continuously (optional, default false)",,,,,,,,,"* An OrderingPolicy which orders SchedulableEntities for fairness (see361* FairScheduler362* FairSharePolicy), generally, processes with lesser usage are lesser",,,,,,,,,3631,FederationPolicyException.java,* Generic policy exception.,Generic policy exception,,,,,,,,,,,,,,,,,,,,,,3641,FederationProtocolPBTranslator.java,"* Helper class for setting/getting data elements in an object backed by a365* protobuf implementation.",Helper class for setting/getting data elements in an object backed by a * protobuf implementation.,,for setting/getting data elements in an object backed by a * protobuf implementation.,,,* Thrown when an arguments are combined to construct a * <code>AMRMClient.ContainerRequest</code> in an invalid way.,,,,,,,,,,,,,,,,,3661,FederationStateStoreInvalidInputException.java,"* Exception thrown by the {@code FederationMembershipStateStoreInputValidator},367* {@code FederationApplicationHomeSubClusterStoreInputValidator},368* {@code FederationPolicyStoreInputValidator} if the input is invalid.369*","Exception thrown by the {@code FederationMembershipStateStoreInputValidator},",,,,,"* Exception thrown by the {@code FederationMembershipStateStoreInputValidator}, * {@code FederationApplicationHomeSubClusterStoreInputValidator}, * {@code FederationPolicyStoreInputValidator} if the input is invalid.",,,,,,,,"* Exception thrown by the {@code FederationMembershipStateStoreInputValidator}, * {@code FederationApplicationHomeSubClusterStoreInputValidator}, * {@code FederationPolicyStoreInputValidator} if the input is invalid.",,,,,,,,,3701,FileSystemApplicationHistoryStore.java,"* File system implementation of {@link ApplicationHistoryStore}. In this371* implementation, one application will have just one file in the file system,372* which contains all the history data of one application, and its attempts and373* containers. {@link #applicationStarted(ApplicationStartData)} is supposed to374* be invoked first when writing any history data of one application and it will375* open a file, while {@link #applicationFinished(ApplicationFinishData)} is376* supposed to be last writing operation and will close the file.",* File system implementation of {@link ApplicationHistoryStore}.,"In this * implementation, one application will have just one file in the file system, * which contains all the history data of one application, and its attempts and * containers. {@link #applicationStarted(ApplicationStartData)} is supposed to377* be invoked first when writing any history data of one application and it will378* open a file, while {@link #applicationFinished(ApplicationFinishData)} is379* supposed to be last writing operation and will close the file.",,,,,,,,,,,,"* File system implementation of {@link ApplicationHistoryStore}. {@link #applicationStarted(ApplicationStartData)} is supposed to380* be invoked first when writing any history data of one application and it will381* open a file, while {@link #applicationFinished(ApplicationFinishData)} is382* supposed to be last writing operation and will close the file.",,,,,,,,,3831,FsConstants.java,* FileSystem related constants.,FileSystem related constants,,,,,,,,,,,,,,,,,,,,,,3841,GetApplicationHomeSubClusterResponsePBImpl.java,"* Protocol buffer based implementation of385* {@link GetApplicationHomeSubClusterResponse}.",Protocol buffer based implementation of * {@link GetApplicationHomeSubClusterResponse}.,,,,,,,,,,,,,Protocol buffer based implementation of * {@link GetApplicationHomeSubClusterResponse}.,,,,,,,,,3861,GetNamespaceInfoResponse.java,* API response for listing HDFS namespaces present in the state store.,API response for listing HDFS namespaces present in the state store.,,,,,,,,,,,,,,,,,,,,,,3871,GetNodesToAttributesResponse.java,"* <p>388* The response sent by the <code>ResourceManager</code> to a client requesting389* nodes to attributes mapping.390* </p>391*392* @see ApplicationClientProtocol#getNodesToAttributes393* (GetNodesToAttributesRequest)",The response sent by the <code>ResourceManager</code> to a client requesting * nodes to attributes mapping.,,,,,,,,,,,,,@see ApplicationClientProtocol#getNodesToAttributes * (GetNodesToAttributesRequest),,,,,,,,,3941,GetSafeModeRequestPBImpl.java,"* Protobuf implementation of the state store API object395* GetSafeModeRequest.",Protobuf implementation of the state store API object * GetSafeModeRequest.,,,,,,,,,,,,,,,,,,,,,,3961,GetSubClusterPolicyConfigurationRequestPBImpl.java,"* Protocol buffer based implementation of397* {@link GetSubClusterPolicyConfigurationRequest}.",Protocol buffer based implementation of * {@link GetSubClusterPolicyConfigurationRequest}.,,,,,,,,,,,,,Protocol buffer based implementation of * {@link GetSubClusterPolicyConfigurationRequest}.,,,,,,,,,3981,HadoopIllegalArgumentException.java,"* Indicates that a method has been passed illegal or invalid argument. This399* exception is thrown instead of IllegalArgumentException to differentiate the400* exception thrown in Hadoop implementation from the one thrown in JDK.",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.,,,,This * exception is thrown instead of IllegalArgumentException to differentiate the * exception thrown in Hadoop implementation from the one thrown in JDK.,,,,,,,,,,,,,,,,,4011,HashResolver.java,* Order the destinations based on consistent hashing.,Order the destinations based on consistent hashing.,,,,,,,,,,,,,,,,,,,,,,4021,HttpHeaderConfigurations.java,* Responsible to keep all abfs http headers here.,,Responsible to keep all abfs http headers here.,,,,,,,,,,,,,,,,,,,,,4031,IDataLoader.java,* an IDataLoader loads data on demand,an IDataLoader loads data on demand,,,,,,,,,,,,,,,,,,,,,,4041,InconsistentS3ClientFactory.java,"* S3 Client factory used for testing with eventual consistency fault injection.405* This client is for testing <i>only</i>; it is in the production406* {@code hadoop-aws} module to enable integration tests to use this407* just by editing the Hadoop configuration used to bring up the client.",S3 Client factory used for testing with eventual consistency fault injection.,,,,"This client is for testing <i>only</i>; it is in the production408* {@code hadoop-aws} module to enable integration tests to use this409* just by editing the Hadoop configuration used to bring up the client.",,,,,,,,,,,,,,,,,,4101,InfoKeyHandler.java,* Executes Info Object.,Executes Info Object,,,,,,,,,,,,,,,,,,,,,,4111,InvalidContainerRequestException.java,"* Thrown when an arguments are combined to construct a412* <code>AMRMClient.ContainerRequest</code> in an invalid way.",* Thrown when an arguments are combined to construct a * <code>AMRMClient.ContainerRequest</code> in an invalid way.,,,,,,,,,,,,,,,,,,,,,,4131,ITestAbfsReadWriteAndSeek.java,"* Test read, write and seek.414* Uses package-private methods in AbfsConfiguration, which is why it is in415* this package.","Test read, write and seek.",,"Uses package-private methods in AbfsConfiguration, which is why it is in * this package.",,,,,,,,,,,,,,,,,,,,4161,ITestAzureNativeContractSeek.java,* Contract test.,Contract test,,,,,,,,,,,,,,,,,,,,,,4171,ITestCommitOperations.java,"* Test the low-level binding of the S3A FS to the magic commit mechanism,418* and handling of the commit operations.419* This is done with an inconsistent client.","* Test the low-level binding of the S3A FS to the magic commit mechanism, * and handling of the commit operations.",,,,This is done with an inconsistent client.,,,,,,,,,,,,,,,,,,4201,ITestListPerformance.java,* Test list performance.,Test list performance,,,,,,,,,,,,,,,,,,,,,,4211,ITestS3Select.java,"* Test the S3 Select feature with some basic SQL Commands.422* Executed if the destination store declares its support for the feature.",Test the S3 Select feature with some basic SQL Commands.,Executed if the destination store declares its support for the feature.,,,,,,,,,,,,,,,,,,,,,4231,ITestS3SelectCLI.java,"* Test the S3 Select CLI through some operations against landsat424* and files generated from it.",Test the S3 Select CLI through some operations against landsat * and files generated from it.,,,,,,,,,,,,,,,,,,,,,,4251,KerberosDelegationTokenAuthenticator.java,"* The <code>KerberosDelegationTokenAuthenticator</code> provides support for426* Kerberos SPNEGO authentication mechanism and support for Hadoop Delegation427* Token operations.428* <p>429* It falls back to the {@link PseudoDelegationTokenAuthenticator} if the HTTP430* endpoint does not trigger a SPNEGO authentication","The <code>KerberosDelegationTokenAuthenticator</code> provides support for431* Kerberos SPNEGO authentication mechanism and support for Hadoop Delegation432* Token operations.","It falls back to the {@link PseudoDelegationTokenAuthenticator} if the HTTP433* endpoint does not trigger a SPNEGO authentication",,,,,,,,,,,,"It falls back to the {@link PseudoDelegationTokenAuthenticator} if the HTTP434* endpoint does not trigger a SPNEGO authentication",,,,,,,,,4351,LocalizationStatusPBImpl.java,* PB Impl of {@link LocalizationStatus}.,PB Impl of {@link LocalizationStatus}.,,,,,,,,,,,,,PB Impl of {@link LocalizationStatus}.,,,,,,,,,4361,LocatedFileStatus.java,* This class defines a FileStatus that includes a file's block locations.,This class defines a FileStatus that includes a file's block locations,,,,,,,,,,,,,,,,,,,,,,4371,LoggedTask.java,"* A {@link LoggedTask} represents a [hadoop] task that is part of a hadoop job.438* It knows about the [pssibly empty] sequence of attempts, its I/O footprint,439* and its runtime.440* * All of the public methods are simply accessors for the instance variables we441* want to write out in the JSON files.442*",A {@link LoggedTask} represents a [hadoop] task that is part of a hadoop job.,"It knows about the [pssibly empty] sequence of attempts, its I/O footprint,443* and its runtime.",,,"All of the public methods are simply accessors for the instance variables we444* want to write out in the JSON files.445*",,,,,,,,,A {@link LoggedTask} represents a [hadoop] task that is part of a hadoop job.,,,,,,,,,4461,LogParserUtil.java,* Common utility functions for {@link LogParser}.,Common utility functions for {@link LogParser},,,,,,,,,,,,,Common utility functions for {@link LogParser},,,,,,,,,4471,LogWebService.java,* Support only ATSv2 client only.,,,,Support only ATSv2 client only,,,,,,,,,,,,,,,,,,,4481,LRUCacheHashMap.java,* LRU cache with a configurable maximum cache size and access order.,LRU cache with a configurable maximum cache size and access order.,LRU cache with a configurable maximum cache size and access order.,,,,,,,,,,,,,,,,,,,,,4491,MapContext.java,"* The context that is given to the {@link Mapper}.450* @param <KEYIN> the key input type to the Mapper451* @param <VALUEIN> the value input type to the Mapper452* @param <KEYOUT> the key output type from the Mapper453* @param <VALUEOUT> the value output type from the Mapper",The context that is given to the {@link Mapper}.,,,,"* @param <KEYIN> the key input type to the Mapper454* @param <VALUEIN> the value input type to the Mapper455* @param <KEYOUT> the key output type from the Mapper456* @param <VALUEOUT> the value output type from the Mapper",,,,,,,,,* The context that is given to the {@link Mapper}. * @param <KEYIN> the key input type to the Mapper * @param <VALUEIN> the value input type to the Mapper * @param <KEYOUT> the key output type from the Mapper * @param <VALUEOUT> the value output type from the Mapper,,,,,,,,,4571,MetaBlockAlreadyExists.java,* Exception - Meta Block with the same name already exists.,Exception - Meta Block with the same name already exists.,,,,,,,,,,,,,,,,,,,,,,4581,MetricsCache.java,"* A metrics cache for sinks that don't support sparse updates.459|460* Cached record",A metrics cache for sinks that don't support sparse updates. Context of the Queues in Scheduler.,Cached record,,,,,,,,,,,,,,,,,,,,,4611,NativeBatchProcessor.java,"* used to create channel, transfer data and command between Java and native",,,"used to create channel, transfer data and command between Java and native",,,,,,,,,,,,,,,,,,,,4621,NativeSingleLineParser.java,"* This sample parser will parse the sample log and extract the resource463* skyline.464* <p> The expected log format is: NormalizedJobName NumInstances SubmitTime465* StartTime EndTime JobInstanceName memUsage coreUsage","This sample parser will parse the sample log and extract the resource466* skyline.","<p> The expected log format is: NormalizedJobName NumInstances SubmitTime467* StartTime EndTime JobInstanceName memUsage coreUsage",,,,,,,,,,,,,,,,,,,,,4681,Nfs3Metrics.java,"* This class is for maintaining the various NFS gateway activity statistics and469* publishing them through the metrics interfaces.",This class is for maintaining the various NFS gateway activity statistics and * publishing them through the metrics interfaces.,,,,,,,,,,,,,,,,,,,,,,4701,Nfs3Status.java,* Success or error status is reported in NFS3 responses.,* Success or error status is reported in NFS3 responses.,,,,,,,,,,,,,,,,,,,,,,4711,Node2ObjectsMap.java,"* This data structure maintains the list of containers that is on a datanode.472* This information is built from the DN container reports.",This data structure maintains the list of containers that is on a datanode.,This information is built from the DN container reports.,,,,,,,,,,,,,,,,,,,,,4731,NodeUpdateType.java,"* <p>Taxonomy of the <code>NodeState</code> that a474* <code>Node</code> might transition into.</p>475*",<p>Taxonomy of the <code>NodeState</code> that a * <code>Node</code> might transition into.</p>,<p>Taxonomy of the <code>NodeState</code> that a * <code>Node</code> might transition into.</p>,,,,,,,,,,,,,,,,,,,,,4761,NullOutputFormat.java,* Consume all outputs and put them in /dev/null.,Consume all outputs and put them in /dev/null.,Consume all outputs and put them in /dev/null.,,,,,,,,,,,,,,,,,,,,,4771,OMNodeDetails.java,"* This class stores OM node details.478|479* Builder class for OMNodeDetails.","* This class stores OM node details.480|481* Builder class for OMNodeDetails.",,,,,,,,,,,,,* Builder class for OMNodeDetails.,,,,,,,,,4821,OpportunisticContainersStatusPBImpl.java,* Protocol Buffer implementation of OpportunisticContainersStatus.,Protocol Buffer implementation of OpportunisticContainersStatus,,,,,,,,,,,,,,,,,,,,,,4831,OzoneObj.java,"* Class representing an unique ozone object.484* |485* Ozone Objects supported for ACL.486|487* Ozone Objects supported for ACL.",Class representing an unique ozone object,Ozone Objects supported for ACL.,,,,,,,,,,,,,,,,,,,,,4881,Parser.java,A class for parsing outputs,A class for parsing outputs,,,,,,,,,,,,,,,,,,,,,,4891,PartialOutputCommitter.java,"* Interface for an {@link org.apache.hadoop.mapreduce.OutputCommitter}490* implementing partial commit of task output, as during preemption.","* Interface for an {@link org.apache.hadoop.mapreduce.OutputCommitter} * implementing partial commit of task output, as during preemption.",,,,,,,,,,,,,Interface for an {@link org.apache.hadoop.mapreduce.OutputCommitter},,,,,,,,,4911,PartitionResourcesInfo.java,* This class represents queue/user resource usage info for a given partition,This class represents queue/user resource usage info for a given partition,,This class represents queue/user resource usage info for a given partition,,,,,,,,,,,,,,,,,,,,4921,PlanningQuotaException.java,"* This exception is thrown if the user quota is exceed while accepting or493* updating a reservation.",This exception is thrown if the user quota is exceed while accepting or * updating a reservation.,,,,,,,,,,,,,,,,,,,,,,4941,ProcessIdFileReader.java,* Helper functionality to read the pid from a file.,Helper functionality to read the pid from a file.,,,,,,,,,,,,,,,,,,,,,,4951,QuasiMonteCarlo.java,"* A map/reduce program that estimates the value of Pi496* using a quasi-Monte Carlo (qMC) method.497* Arbitrary integrals can be approximated numerically by qMC methods.498* In this example,499* we use a qMC method to approximate the integral $I = \int_S f(x) dx$,500* where $S=[0,1)^2$ is a unit square,501* $x=(x_1,x_2)$ is a 2-dimensional point,502* and $f$ is a function describing the inscribed circle of the square $S$,503* $f(x)=1$ if $(2x_1-1)^2+(2x_2-1)^2 &lt;= 1$ and $f(x)=0$, otherwise.504* It is easy to see that Pi is equal to $4I$.505* So an approximation of Pi is obtained once $I$ is evaluated numerically.506* * There are better methods for computing Pi.507* We emphasize numerical approximation of arbitrary integrals in this example.508* For computing many digits of Pi, consider using bbp.509*510* The implementation is discussed below.511*512* Mapper:513* Generate points in a unit square514* and then count points inside/outside of the inscribed circle of the square.515*516* Reducer:517* Accumulate points inside/outside results from the mappers.518*519* Let numTotal = numInside + numOutside.520* The fraction numInside/numTotal is a rational approximation of521* the value (Area of the circle)/(Area of the square) = $I$,522* where the area of the inscribed circle is Pi/4523* and the area of unit square is 1.524* Finally, the estimated value of Pi is 4(numInside/numTotal). | 2-dimensional Halton sequence {H(i)},525* where H(i) is a 2-dimensional point and i >= 1 is the index.526* Halton sequence is used to generate sample points for Pi estimation. |527* Mapper class for Pi estimation.528* Generate points in a unit square529* and then count points inside/outside of the inscribed circle of the square.530|531* Reducer class for Pi estimation.532* Accumulate points inside/outside results from the mappers.",* A map/reduce program that estimates the value of Pi.,"using a quasi-Monte Carlo (qMC) method. Arbitrary integrals can be approximated numerically by qMC methods. * There are better methods for computing Pi.533* We emphasize numerical approximation of arbitrary integrals in this example.534* For computing many digits of Pi, consider using bbp.535*536* The implementation is discussed below.537*538* Mapper:539* Generate points in a unit square540* and then count points inside/outside of the inscribed circle of the square.541*542* Reducer:543* Accumulate points inside/outside results from the mappers. * Mapper class for Pi estimation.544* Generate points in a unit square545* and then count points inside/outside of the inscribed circle of the square.546|547* Reducer class for Pi estimation.548* Accumulate points inside/outside results from the mappers.",,,"In this example,549* we use a qMC method to approximate the integral $I = \int_S f(x) dx$,550* where $S=[0,1)^2$ is a unit square,551* $x=(x_1,x_2)$ is a 2-dimensional point,552* and $f$ is a function describing the inscribed circle of the square $S$,553* $f(x)=1$ if $(2x_1-1)^2+(2x_2-1)^2 &lt;= 1$ and $f(x)=0$, otherwise.554* It is easy to see that Pi is equal to $4I$.555* So an approximation of Pi is obtained once $I$ is evaluated numerically.556* * There are better methods for computing Pi.557* We emphasize numerical approximation of arbitrary integrals in this example.558* For computing many digits of Pi, consider using bbp.559*",,,,,,,,,"In this example,560* we use a qMC method to approximate the integral $I = \int_S f(x) dx$,",,,,"For computing many digits of Pi, consider using bbp.",,,,,5611,Query.java,"* Check if a record matches a query. The query is usually a partial record.562*563* @param <T> Type of the record to query.",Check if a record matches a query.,The query is usually a partial record.,,,,,,,,,,,,* @param <T> Type of the record to query.,,,,,,,,,5641,QueueName.java,* Represents a queue name.,Represents a queue name.,,,,,,,,,,,,,,,,,,,,,,5651,RandomKeyGenerator.java,"* Data generator tool to generate as much keys as possible.566|567* Wrapper to hold ozone keyValidate entry.568|569* Validates the write done in ozone cluster.",Data generator tool to generate as much keys as possible.,"Wrapper to hold ozone keyValidate entry.570|571* Validates the write done in ozone cluster.",,,,,,,,,,,,,,,,,,,,,5721,ReencryptionUpdater.java,"* Class for finalizing re-encrypt EDEK operations, by updating file xattrs with573* edeks returned from reencryption.574* <p>575* The tasks are submitted by ReencryptionHandler.576* <p>577* It is assumed only 1 Updater will be running, since updating file xattrs578* requires namespace write lock, and performance gain from multi-threading579* is limited.580|581* Class to track re-encryption submissions of a single zone. It contains582* all the submitted futures, and statistics about how far the futures are583* processed.584|585* Class representing the task for one batch of a re-encryption command. It586* also contains statistics about how far this single batch has been executed.587|588* Class that encapsulates re-encryption details of a file.","Class for finalizing re-encrypt EDEK operations. Class representing the task for one batch of a re-encryption command. It589* also contains statistics about how far this single batch has been executed. Class that encapsulates re-encryption details of a file.","by updating file xattrs with * edeks returned from reencryption. * <p> * The tasks are submitted by ReencryptionHandler. * <p>. It is assumed only 1 Updater will be running, since updating file xattrs590* requires namespace write lock, and performance gain from multi-threading591* is limited.592|593* Class to track re-encryption submissions of a single zone. It contains594* all the submitted futures, and statistics about how far the futures are595* processed. It contains the596* file inode, stores the initial edek of the file, and the new edek597* after re-encryption.598* <p>599* Assumptions are the object initialization happens when dir lock is held,600* and inode is valid and is encrypted during initialization.601* <p>602* Namespace changes may happen during re-encryption, and if inode is changed603* the re-encryption is skipped.",Class for finalizing re-encrypt EDEK operations,,,,,,,,,,,,,,,,,,,,6041,RegistryInternalConstants.java,"* Internal constants for the registry.605*606* These are the things which aren't visible to users.607*",Internal constants for the registry.,,These are the things which aren't visible to users.,,,,,,,,,,,,,,,,,,,,6081,RegistryOperations.java,* Registry Operations,Registry Operations,,,,,,,,,,,,,,,,,,,,,,6091,ReInitializeContainerRequestPBImpl.java,CHECKSTYLE:OFF,,,,,,,,,,CHECKSTYLE:OFF,,,,,,,,,,,,,6101,ResourceBlacklistRequest.java,"* {@link ResourceBlacklistRequest} encapsulates the list of resource-names * which should be added or removed from the <em>blacklist</em> of resources * for the application.611* * @see ResourceRequest612* @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)",* {@link ResourceBlacklistRequest} encapsulates the list of resource-names * which should be added or removed from the <em>blacklist</em> of resources * for the application.,,,,,,,,,,,,,"* {@link ResourceBlacklistRequest} encapsulates the list of resource-names * which should be added or removed from the <em>blacklist</em> of resources * for the application.613* * @see ResourceRequest614* @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)",,,,,,,,,6151,ResourceRequestsJsonVerifications.java,"* Performs value verifications on616* {@link org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ResourceRequestInfo}617* objects against the values of {@link ResourceRequest}. With the help of the618* {@link Builder}, users can also make verifications of the custom resource619* types and its values.620|621* Builder class for {@link ResourceRequestsJsonVerifications}.","* Performs value verifications on622* {@link org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ResourceRequestInfo}623* objects against the values of {@link ResourceRequest}.624|625* Builder class for {@link ResourceRequestsJsonVerifications}.","With the help of the626* {@link Builder}, users can also make verifications of the custom resource627* types and its values.",,,,,,,,,,,,"* Performs value verifications on628* {@link org.apache.hadoop.yarn.server.resourcemanager.webapp.dao.ResourceRequestInfo}629* objects against the values of {@link ResourceRequest}. With the help of the630* {@link Builder}, users can also make verifications of the custom resource631* types and its values.632|633* Builder class for {@link ResourceRequestsJsonVerifications}.",,,,,,,,,6341,RetriableDirectoryCreateCommand.java,"* This class extends Retriable command to implement the creation of directories635* with retries on failure.",This class extends Retriable command to implement the creation of directories * with retries on failure.,,,,,,,,,,,,,,,,,,,,,,6361,RMAdminRequestInterceptor.java,"* Defines the contract to be implemented by the request intercepter classes,637* that can be used to intercept and inspect messages sent from the client to638* the resource manager.",Defines the contract to be implemented by the request intercepter classes,,,,that can be used to intercept and inspect messages sent from the client to * the resource manager.,,,,,,,,,,,,,,,,,,6391,RSLegacyRawErasureCoderFactory.java,* A raw coder factory for the legacy raw Reed-Solomon coder in Java.,A raw coder factory for the legacy raw Reed-Solomon coder in Java.,,,,,,,,,,,,,,,,,,,,,,6401,SafeModeException.java,"* This exception is thrown when the name node is in safe mode.641* Client cannot modified namespace until the safe mode is off.642*",,,,,Client cannot modified namespace until the safe mode is off.,* This exception is thrown when the name node is in safe mode.,,,,,,,,,,,,,* Client cannot modified namespace until the safe mode is off.,,,,6431,SchedulerQueueManager.java,"*644* Context of the Queues in Scheduler.645*",Context of the Queues in Scheduler.,,,,,,,,,,,,,,,,,,,,,,6461,SequenceFileRecordReader.java,* An {@link RecordReader} for {@link SequenceFile}s.,* An {@link RecordReader} for {@link SequenceFile}s.,,,,,,,,,,,,,* An {@link RecordReader} for {@link SequenceFile}s.,,,,,,,,,6471,ShellBasedUnixGroupsMapping.java,"* A simple shell-based implementation of {@link GroupMappingServiceProvider} * that exec's the <code>groups</code> shell command to fetch the group648* memberships of a given user.",A simple shell-based implementation of {@link GroupMappingServiceProvider},that exec's the <code>groups</code> shell command to fetch the group * memberships of a given user.,,,,,,,,,,,,,,,,,,,,,6491,StandardSocketFactory.java,* Specialized SocketFactory to create sockets with a SOCKS proxy,Specialized SocketFactory to create sockets with a SOCKS proxy,,,,,,,,,,,,,,,,,,,,,,6501,StateStoreFileSystemImpl.java,"* {@link StateStoreDriver} implementation based on a filesystem. The common651* implementation uses HDFS as a backend. The path can be specified setting652* dfs.federation.router.driver.fs.path=hdfs://host:port/path/to/store.",* {@link StateStoreDriver} implementation based on a filesystem.,The common * implementation uses HDFS as a backend.,,,The path can be specified setting * dfs.federation.router.driver.fs.path=hdfs://host:port/path/to/store.,,,,,,,,,* {@link StateStoreDriver} implementation based on a filesystem.,,,,,,,,,6531,StreamBaseRecordReader.java,"* Shared functionality for hadoopStreaming formats. A custom reader can be654* defined to be a RecordReader with the constructor below and is selected with655* the option bin/hadoopStreaming -inputreader ...656* * @see StreamXmlRecordReader",Shared functionality for hadoopStreaming formats.,,,,"A custom reader can be657* defined to be a RecordReader with the constructor below and is selected with658* the option bin/hadoopStreaming -inputreader ...",,,,,,,,,A custom reader can be * defined to be a RecordReader with the constructor below and is selected with * the option bin/hadoopStreaming -inputreader ... * * @see StreamXmlRecordReader,,,,,,,,,6591,StructureGenerator.java,"* This program generates a random namespace structure with the following660* constraints:661* 1. The number of subdirectories is a random number in [minWidth, maxWidth].662* 2. The maximum depth of each subdirectory is a random number * [2*maxDepth/3, maxDepth].663* 3. Files are randomly placed in the empty directories. The size of each664* file follows Gaussian distribution.665* The generated namespace structure is described by two files in the output666* directory. Each line of the first file * contains the full name of a leaf directory. * Each line of the second file contains667* the full name of a file and its size, separated by a blank.668* * The synopsis of the command is669* java StructureGenerator670-maxDepth <maxDepth> : maximum depth of the directory tree; default is 5.671-minWidth <minWidth> : minimum number of subdirectories per directories; default is 1672-maxWidth <maxWidth> : maximum number of subdirectories per directories; default is 5673-numOfFiles <#OfFiles> : the total number of files; default is 10.674-avgFileSize <avgFileSizeInBlocks>: average size of blocks; default is 1.675-outDir <outDir>: output directory; default is the current directory.676-seed <seed>: random number generator seed; default is the current time.677| In memory representation of a directory | In memory representation of a file",This program generates a random namespace structure,"This program generates a random namespace structure with the following678* constraints:679* 1. The number of subdirectories is a random number in [minWidth, maxWidth].680* 2. The maximum depth of each subdirectory is a random number * [2*maxDepth/3, maxDepth].681* 3. Files are randomly placed in the empty directories. The size of each682* file follows Gaussian distribution.683* The generated namespace structure is described by two files in the output684* directory. Each line of the first file * contains the full name of a leaf directory. * Each line of the second file contains685* the full name of a file and its size, separated by a blank.",,,"* The synopsis of the command is686* java StructureGenerator687-maxDepth <maxDepth> : maximum depth of the directory tree; default is 5.688-minWidth <minWidth> : minimum number of subdirectories per directories; default is 1689-maxWidth <maxWidth> : maximum number of subdirectories per directories; default is 5690-numOfFiles <#OfFiles> : the total number of files; default is 10.691-avgFileSize <avgFileSizeInBlocks>: average size of blocks; default is 1.692-outDir <outDir>: output directory; default is the current directory.693-seed <seed>: random number generator seed; default is the current time.694| In memory representation of a directory | In memory representation of a file",,,,,,,,,,,,,,,,,,6951,SwiftBadRequestException.java,"* Thrown to indicate that data locality can't be calculated or requested path is incorrect.696* Data locality can't be calculated if Openstack Swift version is old.",Thrown to indicate that data locality can't be calculated or requested path is incorrect.,,,Data locality can't be calculated if Openstack Swift version is old.,,,,,,,,,,,,,,,,,,,6971,SwiftRestClient.java,"* This implements the client-side of the Swift REST API.698*699* The core actions put, get and query data in the Swift object store,700* after authenticating the client.701*702* <b>Logging:</b>703*704* Logging at DEBUG level displays detail about the actions of this705* client, including HTTP requests and responses -excluding authentication706* details.707|708* Get the current operation statistics.709* @return a snapshot of the statistics710|711* Base class for all Swift REST operations.712*713* @param <M> request714* @param <R> result715|716* Get the current operation statistics.717* @return a snapshot of the statistics718|719* There's a special type for auth messages, so that low-level720* message handlers can react to auth failures differently from everything721* else.722|723* Get the current operation statistics.724* @return a snapshot of the statistics725|726* Generate an auth message.727* @param <R> response728|729* Get the current operation statistics.730* @return a snapshot of the statistics731|732* Create operation.733*734* @param <R> result type735|736* Get the current operation statistics.737* @return a snapshot of the statistics738|739* Delete operation.740*741* @param <R>",* This implements the client-side of the Swift REST API.,"The core actions put, get and query data in the Swift object store, * after authenticating the client. * * <b>Logging:</b> * * Logging at DEBUG level displays detail about the actions of this * client, including HTTP requests and responses -excluding authentication * details.",,,,"* There's a special type for auth messages, so that low-level742* message handlers can react to auth failures differently from everything743* else.744|",,,,,,,,"Get the current operation statistics. * @return a snapshot of the statistics. Base class for all Swift REST operations.745*746* @param <M> request747* @param <R> result748|749* Get the current operation statistics.750* @return a snapshot of the statistics751|752* Get the current operation statistics.753* @return a snapshot of the statistics754|755* Generate an auth message.756* @param <R> response757|758* Get the current operation statistics.759* @return a snapshot of the statistics760|761* Create operation.762*763* @param <R> result type764|765* Get the current operation statistics.766* @return a snapshot of the statistics767|768* Delete operation.769*770* @param <R>",,,,,,,,,7711,TableConfig.java,* Class that maintains Table Configuration.,Class that maintains Table Configuration.,,,,,,,,,,,,,,,,,,,,,,7721,TestAddBlock.java,* Test AddBlockOp is written and read correctly,Test AddBlockOp is written and read correctly,Test AddBlockOp is written and read correctly,,,,,,,,,,,,,,,,,,,,,7731,TestAdlContractDeleteLive.java,* Test delete contract test.,Test delete contract test.,,,,,,,,,,,,,,,,,,,,,,7741,TestAdlContractSeekLive.java,* Test seek operation on Adl file system.,Test seek operation on Adl file system.,,,,,,,,,,,,,,,,,,,,,,7751,TestConfServlet.java,"* Basic test case that the ConfServlet can write configuration776* to its output in XML and JSON format.",Basic test case that the ConfServlet can write configuration * to its output in XML and JSON format.,Basic test case that the ConfServlet can write configuration * to its output in XML and JSON format.,,,,,,,,,,,,,,,,,,,,,7771,TestConnCache.java,"* This class tests the client connection caching in a single node778* mini-cluster.",This class tests the client connection,caching in a single node * mini-cluster.,,,,,,,,,,,,,,,,,,,,,7791,TestCustomOauthTokenProvider.java,"* Test custom OAuth token providers.780* This is a unit test not an E2E integration test because that would781* require OAuth auth setup, always.782* Instead this just checks that the creation works and that everything783* is propagated.",Test custom OAuth token providers.,"Instead this just checks that the creation works and that everything784* is propagated.","This is a unit test not an E2E integration test because that would * require OAuth auth setup, always.",,,,,,,,,,,,,,,,,,,,7851,TestDataDrivenDBInputFormat.java,"import org.apache.hadoop.examples.DBCountPageView;|786* Test aspects of DataDrivenDBInputFormat",Test aspects of DataDrivenDBInputFormat,,,,,,,,import org.apache.hadoop.examples.DBCountPageView;|,,,,,,,,,,,,,,7871,TestDominantResourceFairnessPolicy.java,"* comparator.compare(sched1, sched2) < 0 means that sched1 should get a788* container before sched2",,"comparator.compare(sched1, sched2) < 0 means that sched1 should get a * container before sched2",,,,,,,,,,,,,,,,,,,,,7891,TestEditLogFileOutputStream.java,* Test the EditLogFileOutputStream,Test the EditLogFileOutputStream,,,,,,,,,,,,,,,,,,,,,,7901,TestFederationPolicyUtils.java,* Unit test for {@link FederationPolicyUtils}.,Unit test for {@link FederationPolicyUtils}.,,,,,,,,,,,,,Unit test for {@link FederationPolicyUtils}.,,,,,,,,,7911,TestFileSizeCountTask.java,* Unit test for File Size Count Task.,Unit test for File Size Count Task,,,,,,,,,,,,,,,,,,,,,,7921,TestHandler.java,* Tests Handler interface.,Tests Handler interface.,,,,,,,,,,,,,,,,,,,,,,7931,TestHDFSServerPorts.java,"* This test checks correctness of port usage by hdfs components:794* NameNode, DataNode, SecondaryNamenode and BackupNode.795* * The correct behavior is:<br> * - when a specific port is provided the server must either start on that port * or fail by throwing {@link java.net.BindException}.<br>796* - if the port = 0 (ephemeral) then the server should choose * a free port and start on it.","* This test checks correctness of port usage by hdfs components:797* NameNode, DataNode, SecondaryNamenode and BackupNode.","* * The correct behavior is:<br> * - when a specific port is provided the server must either start on that port * or fail by throwing {@link java.net.BindException}.<br>798* - if the port = 0 (ephemeral) then the server should choose * a free port and start on it.",,,,* * The correct behavior is:<br> * - when a specific port is provided the server must either start on that port * or fail by throwing {@link java.net.BindException},,,,,,,,,,,,,,,,,7991,TestKeyInputStream.java,* Tests {@link KeyInputStream}.,Tests {@link KeyInputStream}.,,,,,,,,,,,,,Tests {@link KeyInputStream}.,,,,,,,,,8001,TestMetricsVisitor.java,* Test the metric visitor interface,Test the metric visitor interface,,,,,,,,,,,,,,,,,,,,,,8011,TestNativeAzureFileSystemUploadLogic.java,"* Tests for the upload, buffering and flush logic in WASB.802| Just an arbitrary number so that the values I write have a predictable|803* Various scenarios to test in how often we flush data while uploading.","Tests for the upload, buffering and flush logic in WASB.",| Just an arbitrary number so that the values I write have a predictable|,* Various scenarios to test in how often we flush data while uploading.,,,,,,,,,,,,,,,,,,,,8041,TestOmMultipartKeyInfoCodec.java,* This class tests OmMultipartKeyInfoCodec.,This class tests OmMultipartKeyInfoCodec.,,,,,,,,,,,,,,,,,,,,,,8051,TestOMVolumeRequest.java,* Base test class for Volume request.,Base test class for Volume request,,Base test class for Volume request,,,,,,,,,,,,,,,,,,,,8061,TestOzoneNativeAuthorizer.java,* Test class for {@link OzoneNativeAuthorizer}.,Test class for {@link OzoneNativeAuthorizer}.,,,,,,,,,,,,,Test class for {@link OzoneNativeAuthorizer}.,,,,,,,,,8071,TestProtoBufRpc.java,"* Test for testing protocol buffer based RPC mechanism.808* This test depends on test.proto definition of types in src/test/proto809* and protobuf service definition from src/test/test_rpc_service.proto",Test for testing protocol buffer based RPC mechanism.,"This test depends on test.proto definition of types in src/test/proto810* and protobuf service definition from src/test/test_rpc_service.proto",,,,,,,,,,,,,,,,,,,,,8111,TestRDBStore.java,* RDBStore Tests.,RDBStore Tests.,,,,,,,,,,,,,,,,,,,,,,8121,TestRegistrySecurityHelper.java,* Test for registry security operations,Test for registry security operations,,,,,,,,,,,,,,,,,,,,,,8131,TestRollingFileSystemSinkWithLocal.java,"* Test the {@link RollingFileSystemSink} class in the context of the local file814* system.",Test the {@link RollingFileSystemSink} class in the context of the local file * system.,,,,,,,,,,,,,Test the {@link RollingFileSystemSink} class in the context of the local file * system.,,,,,,,,,8151,TestRouterWebServiceUtil.java,* Test class to validate RouterWebServiceUtil methods.,Test class to validate RouterWebServiceUtil methods.,,,,,,,,,,,,,,,,,,,,,,8161,TestS3BucketManager.java,* Tests for S3 Bucket Manager.,Tests for S3 Bucket Manager.,,,,,,,,,,,,,Tests for S3 Bucket Manager.,,,,,,,,,8171,TestSaveNamespace.java,"* Test various failure scenarios during saveNamespace() operation.818* Cases covered:819* <ol>820* <li>Recover from failure while saving into the second storage directory</li>821* <li>Recover from failure while moving current into lastcheckpoint.tmp</li>822* <li>Recover from failure while moving lastcheckpoint.tmp into823* previous.checkpoint</li>824* <li>Recover from failure while rolling edits file</li>825* </ol>",Test various failure scenarios during saveNamespace() operation.,"Cases covered:826* <ol>827* <li>Recover from failure while saving into the second storage directory</li>828* <li>Recover from failure while moving current into lastcheckpoint.tmp</li>829* <li>Recover from failure while moving lastcheckpoint.tmp into830* previous.checkpoint</li>831* <li>Recover from failure while rolling edits file</li>832* </ol>",,,,,,,,,,,,,,,,,,,,,8331,TestSCMDatanodeHeartbeatDispatcher.java,* This class tests the behavior of SCMDatanodeHeartbeatDispatcher.,This class tests the behavior of SCMDatanodeHeartbeatDispatcher.,,,,,,,,,,,,,,,,,,,,,,8341,TestSequenceFile.java,Support for flat files of binary key/value pairs.,Support for flat files of binary key/value pairs,Support for flat files of binary key/value pairs,,,,,,,,,,,,,,,,,,,,,8351,TestSeveralNameNodes.java,* Test that we can start several and run with namenodes on the same minicluster,Test that we can start several and run with namenodes on the same minicluster,we can start several and run with namenodes on the same minicluster,,,,,,,,,,,,,,,,,,,,,8361,TestSwiftFileSystemContract.java,"* This is the full filesystem contract test -which requires the837* Default config set up to point to a filesystem.838*839* Some of the tests override the base class tests -these840* are where SwiftFS does not implement those features, or841* when the behavior of SwiftFS does not match the normal842* contract -which normally means that directories and equal files843* are being treated as equal.","* This is the full filesystem contract test -which requires the844* Default config set up to point to a filesystem.",,"* Some of the tests override the base class tests -these845* are where SwiftFS does not implement those features, or846* when the behavior of SwiftFS does not match the normal847* contract -which normally means that directories and equal files848* are being treated as equal.",,,,,,,,,,,,,,,,,,,"* Some of the tests override the base class tests -these849* are where SwiftFS does not implement those features, or850* when the behavior of SwiftFS does not match the normal851* contract -which normally means that directories and equal files852* are being treated as equal.",8531,TestTaskCommit.java,"* Special Committer that does not cleanup temporary files in854* abortTask855* * The framework's FileOutputCommitter cleans up any temporary856* files left behind in abortTask. We want the test case to857* find these files and hence short-circuit abortTask.858|859* Special committer that always requires commit.","Special Committer that does not cleanup temporary files in860* abortTask",,"The framework's FileOutputCommitter cleans up any temporary861* files left behind in abortTask. We want the test case to862* find these files and hence short-circuit abortTask.",,* Special committer that always requires commit.,,,,,,,,,,,,,,,,,,8631,TestTaskContext.java,* Tests context api and {@link StatusReporter#getProgress()} via * {@link TaskAttemptContext#getProgress()} API .,Tests context api and {@link StatusReporter#getProgress()} via * {@link TaskAttemptContext#getProgress()} API .,,,,,,,,,,,,,Tests context api and {@link StatusReporter#getProgress()} via * {@link TaskAttemptContext#getProgress()} API .,,,,,,,,,8641,TestTopCLI.java,"* Test class for TopCli.865*",Test class for TopCli.,,,,,,,,,,,,,,,,,,,,,,8661,TestUpgradeDomainBlockPlacementPolicy.java,"* End-to-end test case for upgrade domain867* The test configs upgrade domain for nodes via admin json868* config file and put some nodes to decommission state.869* The test then verifies replicas are placed on the nodes that870* satisfy the upgrade domain policy.871*",End-to-end test case for upgrade domain,"The test configs upgrade domain for nodes via admin json872* config file and put some nodes to decommission state.873* The test then verifies replicas are placed on the nodes that874* satisfy the upgrade domain policy.",,,,,,,,,,,,,,,,,,,,,8751,TextInputFormat.java,"* An {@link InputFormat} for plain text files. Files are broken into lines.876* Either linefeed or carriage-return are used to signal end of line. Keys are877* the position in the file, and values are the line of text..",An {@link InputFormat} for plain text files. Files are broken into lines.,"Either linefeed or carriage-return are used to signal end of line. Keys are * the position in the file, and values are the line of text..",,,,,,,,,,,,An {@link InputFormat} for plain text files. Files are broken into lines.,,,,,,,,,8781,TimelineDataToRetrieve.java,"* Encapsulates information regarding which data to retrieve for each entity879* while querying.<br>880* Data to retrieve contains the following :<br>881* <ul>882* <li><b>confsToRetrieve</b> - Used for deciding which configs to return883* in response. This is represented as a {@link TimelineFilterList} object884* containing {@link TimelinePrefixFilter} objects. These can either be885* exact config keys' or prefixes which are then compared against config886* keys' to decide configs(inside entities) to return in response. If null887* or empty, all configurations will be fetched if fieldsToRetrieve888* contains {@link Field#CONFIGS} or {@link Field#ALL}. This should not be889* confused with configFilters which is used to decide which entities to890* return instead.</li>891* <li><b>metricsToRetrieve</b> - Used for deciding which metrics to return892* in response. This is represented as a {@link TimelineFilterList} object893* containing {@link TimelinePrefixFilter} objects. These can either be894* exact metric ids' or prefixes which are then compared against metric895* ids' to decide metrics(inside entities) to return in response. If null896* or empty, all metrics will be fetched if fieldsToRetrieve contains897* {@link Field#METRICS} or {@link Field#ALL}. This should not be confused898* with metricFilters which is used to decide which entities to return899* instead.</li>900* <li><b>fieldsToRetrieve</b> - Specifies which fields of the entity901* object to retrieve, see {@link Field}. If null, retrieves 3 fields,902* namely entity id, entity type and entity created time. All fields will903* be returned if {@link Field#ALL} is specified.</li>904* <li><b>metricsLimit</b> - If fieldsToRetrieve contains METRICS/ALL or905* metricsToRetrieve is specified, this limit defines an upper limit to the906* number of metrics to return. This parameter is ignored if METRICS are not to907* be fetched.</li>908* <li><b>metricsTimeStart</b> - Metric values before this timestamp would not909* be retrieved. If null or {@literal <0}, defaults to 0.</li>910* <li><b>metricsTimeEnd</b> - Metric values after this timestamp would not911* be retrieved. If null or {@literal <0}, defaults to {@link Long#MAX_VALUE}.912* </li>913* </ul>","Encapsulates information regarding which data to retrieve for each entity914* while querying.<br>","* Data to retrieve contains the following :<br>915* <ul>916* <li><b>confsToRetrieve</b> - Used for deciding which configs to return917* in response. This is represented as a {@link TimelineFilterList} object918* containing {@link TimelinePrefixFilter} objects. These can either be919* exact config keys' or prefixes which are then compared against config920* keys' to decide configs(inside entities) to return in response. If null921* or empty, all configurations will be fetched if fieldsToRetrieve922* contains {@link Field#CONFIGS} or {@link Field#ALL}. This should not be923* confused with configFilters which is used to decide which entities to924* return instead.</li>925* <li><b>metricsToRetrieve</b> - Used for deciding which metrics to return926* in response. This is represented as a {@link TimelineFilterList} object927* containing {@link TimelinePrefixFilter} objects. These can either be928* exact metric ids' or prefixes which are then compared against metric929* ids' to decide metrics(inside entities) to return in response. If null930* or empty, all metrics will be fetched if fieldsToRetrieve contains931* {@link Field#METRICS} or {@link Field#ALL}. This should not be confused932* with metricFilters which is used to decide which entities to return933* instead.</li>934* <li><b>fieldsToRetrieve</b> - Specifies which fields of the entity935* object to retrieve, see {@link Field}. If null, retrieves 3 fields,936* namely entity id, entity type and entity created time. All fields will937* be returned if {@link Field#ALL} is specified.</li>938* <li><b>metricsLimit</b> - If fieldsToRetrieve contains METRICS/ALL or939* metricsToRetrieve is specified, this limit defines an upper limit to the940* number of metrics to return. This parameter is ignored if METRICS are not to941* be fetched.</li>942* <li><b>metricsTimeStart</b> - Metric values before this timestamp would not943* be retrieved. If null or {@literal <0}, defaults to 0.</li>944* <li><b>metricsTimeEnd</b> - Metric values after this timestamp would not945* be retrieved. If null or {@literal <0}, defaults to {@link Long#MAX_VALUE}.946* </li>947* </ul>",,,,,,,,,,,,"* Data to retrieve contains the following :<br>948* <ul>949* <li><b>confsToRetrieve</b> - Used for deciding which configs to return950* in response. This is represented as a {@link TimelineFilterList} object951* containing {@link TimelinePrefixFilter} objects. These can either be952* exact config keys' or prefixes which are then compared against config953* keys' to decide configs(inside entities) to return in response. If null954* or empty, all configurations will be fetched if fieldsToRetrieve955* contains {@link Field#CONFIGS} or {@link Field#ALL}. This should not be956* confused with configFilters which is used to decide which entities to957* return instead.</li>958* <li><b>metricsToRetrieve</b> - Used for deciding which metrics to return959* in response. This is represented as a {@link TimelineFilterList} object960* containing {@link TimelinePrefixFilter} objects. These can either be961* exact metric ids' or prefixes which are then compared against metric962* ids' to decide metrics(inside entities) to return in response. If null963* or empty, all metrics will be fetched if fieldsToRetrieve contains964* {@link Field#METRICS} or {@link Field#ALL}. This should not be confused965* with metricFilters which is used to decide which entities to return966* instead.</li>967* <li><b>fieldsToRetrieve</b> - Specifies which fields of the entity968* object to retrieve, see {@link Field}. If null, retrieves 3 fields,969* namely entity id, entity type and entity created time. All fields will970* be returned if {@link Field#ALL} is specified.</li>971* <li><b>metricsLimit</b> - If fieldsToRetrieve contains METRICS/ALL or972* metricsToRetrieve is specified, this limit defines an upper limit to the973* number of metrics to return. This parameter is ignored if METRICS are not to974* be fetched.</li>975* <li><b>metricsTimeStart</b> - Metric values before this timestamp would not976* be retrieved. If null or {@literal <0}, defaults to 0.</li>977* <li><b>metricsTimeEnd</b> - Metric values after this timestamp would not978* be retrieved. If null or {@literal <0}, defaults to {@link Long#MAX_VALUE}.979* </li>980* </ul>",,,"<li>This should not be981* confused with configFilters which is used to decide which entities to982* return instead.</li>983<li>This should not be confused984* with metricFilters which is used to decide which entities to return985* instead.</li>986This parameter is ignored if METRICS are not to987* be fetched.</li>988* <li><b>metricsTimeStart</b> - Metric values before this timestamp would not989* be retrieved. If null or {@literal <0}, defaults to 0.</li>990* <li><b>metricsTimeEnd</b> - Metric values after this timestamp would not991* be retrieved. If null or {@literal <0}, defaults to {@link Long#MAX_VALUE}.992* </li>993* </ul>",,,,,,9941,TimelineStorageMonitor.java,"* This abstract class is for monitoring Health of Timeline Storage.995| Different Storages supported by ATSV2.",This abstract class is for monitoring Health of Timeline Storage,,for monitoring Health of Timeline Storage,,,,,,,,,,,,,,,,,,,,9961,TonyRuntimeFactory.java,* Implementation of RuntimeFactory with Tony Runtime,Implementation of RuntimeFactory with Tony Runtime,,,,,,,,,,,,,Implementation of RuntimeFactory with Tony Runtime,,,,,,,,,9971,TypedEvent.java,"* Basic event implementation to implement custom events.998*999* @param <T>",Basic event implementation,,to implement custom events.,,@param <T>,,,,,,,,,,,,,,,,,,10001,UniformSizeInputFormat.java,"* UniformSizeInputFormat extends the InputFormat class, to produce1001* input-splits for DistCp.1002* It looks at the copy-listing and groups the contents into input-splits such1003* that the total-number of bytes to be copied for each input split is1004* uniform.","UniformSizeInputFormat extends the InputFormat class, to produce1005* input-splits for DistCp.","It looks at the copy-listing and groups the contents into input-splits such1006* that the total-number of bytes to be copied for each input split is1007* uniform.",,,,,,,,,,,,,,,,,,,,,10081,Utils.java,"* A utility class. It provides1009* A path filter utility to filter out output/part files in the output dir1010|1011* This class filters output(part) files from the given directory1012* It does not accept files with filenames _logs and _SUCCESS.1013* This can be used to list paths of output directory as follows:1014* Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,1015* new OutputFilesFilter()));1016|1017* This class filters log files from directory given1018* It doesnt accept paths having _logs.1019* This can be used to list paths of output directory as follows:1020* Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,1021* new OutputLogFilter()));","* A utility class. It provides1022* A path filter utility to filter out output/part files in the output dir1023|","* This class filters output(part) files from the given directory1024* It does not accept files with filenames _logs and _SUCCESS.1025|1026* This class filters log files from directory given1027* It doesnt accept paths having _logs.",,,"|1028* This class filters output(part) files from the given directory1029* It does not accept files with filenames _logs and _SUCCESS.1030* This can be used to list paths of output directory as follows:1031* Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,1032* new OutputFilesFilter()));1033|1034* This class filters log files from directory given1035* It doesnt accept paths having _logs.1036* This can be used to list paths of output directory as follows:1037* Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,1038* new OutputLogFilter()));",,,,,,,,,,,,,,,,,,10391,VolumeSet.java,* VolumeSet to manage HDDS volumes in a DataNode.,VolumeSet to manage HDDS volumes in a DataNode.,,,,,,,,,,,,,VolumeSet to manage HDDS volumes in a DataNode.,,,,,,,,,10401,WritableComparator.java,"A Comparator for {@link WritableComparable}s.1041*1042* <p>This base implementation uses the natural ordering. To define alternate1043* orderings, override {@link #compare(WritableComparable,WritableComparable)}.1044*1045* <p>One may optimize compare-intensive operations by overriding1046* {@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are1047* provided to assist in optimized implementations of this method.",A Comparator for {@link WritableComparable}s.,"* <p>This base implementation uses the natural ordering. To define alternate1048* orderings, override {@link #compare(WritableComparable,WritableComparable)}.",,,"<p>This base implementation uses the natural ordering. To define alternate1049* orderings, override {@link #compare(WritableComparable,WritableComparable)}.1050*1051* <p>One may optimize compare-intensive operations by overriding1052* {@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are1053* provided to assist in optimized implementations of this method.",,,,,,,,,"A Comparator for {@link WritableComparable}s.1054*1055* <p>This base implementation uses the natural ordering. To define alternate1056* orderings, override {@link #compare(WritableComparable,WritableComparable)}.1057*1058* <p>One may optimize compare-intensive operations by overriding1059* {@link #compare(byte[],int,int,byte[],int,int)}. Static utility methods are1060* provided to assist in optimized implementations of this method.",,,,,,,,,10611,YarnAuthorizationProvider.java,"* An implementation of the interface will provide authorization related1062* information and enforce permission check. It is excepted that any of the1063* methods defined in this interface should be non-blocking call and should not1064* involve expensive computation as these method could be invoked in RPC.","An implementation of the interface will provide authorization related1065* information and enforce permission check.","It is excepted that any of the1066* methods defined in this interface should be non-blocking call and should not1067* involve expensive computation as these method could be invoked in RPC.","It is excepted that any of the1068* methods defined in this interface should be non-blocking call and should not1069* involve expensive computation as these method could be invoked in RPC.",,,,,,,,,,,,,,,,,,,,10701,YarnServiceJobSubmitter.java,* Submit a job to cluster.,Submit a job to cluster.,,,,,,,,,,,,,,,,,,,,,,10712,ChunkFetchSuccess.java,"* Response to {@link ChunkFetchRequest} when a chunk exists and has been successfully fetched.1072 *1073 * Note that the server-side encoding of this messages does NOT include the buffer itself, as this1074 * may be written by Netty in a more efficient manner (i.e., zero-copy write).1075 * Similarly, the client-side decoding will reuse the Netty ByteBuf as the buffer.",* Response to {@link ChunkFetchRequest} when a chunk exists and has been successfully fetched.,"* Similarly, the client-side decoding will reuse the Netty ByteBuf as the buffer.",,,,,,,,,,,,,,,"* Note that the server-side encoding of this messages does NOT include the buffer itself, as this1076 * may be written by Netty in a more efficient manner (i.e., zero-copy write).1077 * Similarly, the client-side decoding will reuse the Netty ByteBuf as the buffer.",,,,,,10782,ExecutorPlugin.java,"* A plugin which can be automatically instantiated within each Spark executor. Users can specify1079* plugins which should be created with the ""spark.executor.plugins"" configuration. An instance1080* of each plugin will be created for every executor, including those created by dynamic allocation,1081* before the executor starts running any tasks.1082*1083* The specific api exposed to the end users still considered to be very unstable. We will1084* hopefully be able to keep compatibility by providing default implementations for any methods1085* added, but make no guarantees this will always be possible across all Spark releases.1086*1087* Spark does nothing to verify the plugin is doing legitimate things, or to manage the resources1088* it uses. A plugin acquires the same privileges as the user running the task. A bad plugin1089* could also interfere with task execution and make the executor fail in unexpected ways.",A plugin which can be automatically instantiated within each Spark executor.,"Users can specify plugins which should be created with the ""spark.executor.plugins"" configuration. An instance of each plugin will be created for every executor, including those created by dynamic allocation, before the executor starts running any tasks.",,,,,,,,,,,,,,,"* The specific api exposed to the end users still considered to be very unstable. We will1090* hopefully be able to keep compatibility by providing default implementations for any methods1091* added, but make no guarantees this will always be possible across all Spark releases.1092* Spark does nothing to verify the plugin is doing legitimate things, or to manage the resources1093* it uses. A plugin acquires the same privileges as the user running the task. A bad plugin1094* could also interfere with task execution and make the executor fail in unexpected ways.",,,,,,10952,FlatMapFunction.java,* A function that returns zero or more output records from each input record.,* A function that returns zero or more output records from each input record.,,,,,,,,,,,,,,,,,,,,,,10962,JavaRecord.java,Java Bean class to be used with the example JavaSqlNetworkWordCount.,,,,,Java Bean class to be used with the example JavaSqlNetworkWordCount.,,,,,,,,,,,,,,,,,,10972,JavaStreamingTestExample.java,"* Perform streaming testing using Welch's 2-sample t-test on a stream of data, where the data1098 * stream arrives as text files in a directory. Stops when the two groups are statistically1099 * significant (p-value < 0.05) or after a user-specified timeout in number of batches is exceeded.1100 *1101 * The rows of the text files must be in the form `Boolean, Double`. For example:1102 *   false, -3.921103 *   true, 99.321104 *1105 * Usage:1106 *   JavaStreamingTestExample <dataDir> <batchDuration> <numBatchesTimeout>1107 *1108 * To run on your local machine using the directory `dataDir` with 5 seconds between each batch and1109 * a timeout after 100 insignificant batches, call:1110 *    $ bin/run-example mllib.JavaStreamingTestExample dataDir 5 1001111 *1112 * As you add text files to `dataDir` the significance test wil continually update every1113 * `batchDuration` seconds until the test becomes significant (p-value < 0.05) or the number of1114 * batches processed exceeds `numBatchesTimeout`.","* Perform streaming testing using Welch's 2-sample t-test on a stream of data, where the data1115 * stream arrives as text files in a directory. Stops when the two groups are statistically1116 * significant (p-value < 0.05) or after a user-specified timeout in number of batches is exceeded.","The rows of the text files must be in the form `Boolean, Double`. For example:1117 *   false, -3.921118 *   true, 99.32",,,"Usage:1119 *   JavaStreamingTestExample <dataDir> <batchDuration> <numBatchesTimeout>1120 *1121 * To run on your local machine using the directory `dataDir` with 5 seconds between each batch and1122 * a timeout after 100 insignificant batches, call:1123 *    $ bin/run-example mllib.JavaStreamingTestExample dataDir 5 1001124 *1125 * As you add text files to `dataDir` the significance test wil continually update every1126 * `batchDuration` seconds until the test becomes significant (p-value < 0.05) or the number of1127 * batches processed exceeds `numBatchesTimeout`.",,,,,,,,,,,,,,,,,,11282,KVStore.java,"* Abstraction for a local key/value store for storing app data.1129 *1130 * <p>1131 * There are two main features provided by the implementations of this interface:1132 * </p>1133 *1134 * <h3>Serialization</h3>1135 *1136 * <p>1137 * If the underlying data store requires serialization, data will be serialized to and deserialized1138 * using a {@link KVStoreSerializer}, which can be customized by the application. The serializer is1139 * based on Jackson, so it supports all the Jackson annotations for controlling the serialization of1140 * app-defined types.1141 * </p>1142 *1143 * <p>1144 * Data is also automatically compressed to save disk space.1145 * </p>1146 *1147 * <h3>Automatic Key Management</h3>1148 *1149 * <p>1150 * When using the built-in key management, the implementation will automatically create unique1151 * keys for each type written to the store. Keys are based on the type name, and always start1152 * with the ""+"" prefix character (so that it's easy to use both manual and automatic key1153 * management APIs without conflicts).1154 * </p>1155 *1156 * <p>1157 * Another feature of automatic key management is indexing; by annotating fields or methods of1158 * objects written to the store with {@link KVIndex}, indices are created to sort the data1159 * by the values of those properties. This makes it possible to provide sorting without having1160 * to load all instances of those types from the store.1161 * </p>1162 *1163 * <p>1164 * KVStore instances are thread-safe for both reads and writes.1165 * </p>",* Abstraction for a local key/value store for storing app data.,"<p>1166 * There are two main features provided by the implementations of this interface:1167 * </p>1168 *1169 * <h3>Serialization</h3>1170 *1171 * <p>1172 * If the underlying data store requires serialization, data will be serialized to and deserialized1173 * using a {@link KVStoreSerializer}, which can be customized by the application. The serializer is1174 * based on Jackson, so it supports all the Jackson annotations for controlling the serialization of1175 * app-defined types.1176 * </p>1177 *1178 * <p>1179 * Data is also automatically compressed to save disk space.1180 * </p>1181 *1182 * <h3>Automatic Key Management</h3>1183 *1184 * <p>1185 * When using the built-in key management, the implementation will automatically create unique1186 * keys for each type written to the store. Keys are based on the type name, and always start1187 * with the ""+"" prefix character (so that it's easy to use both manual and automatic key1188 * management APIs without conflicts).1189 * </p>1190 *1191 * <p>1192 * Another feature of automatic key management is indexing; by annotating fields or methods of1193 * objects written to the store with {@link KVIndex}, indices are created to sort the data1194 * by the values of those properties. This makes it possible to provide sorting without having1195 * to load all instances of those types from the store.1196 * </p>1197 *1198 * <p>1199 * KVStore instances are thread-safe for both reads and writes.1200 * </p>",,,,,,,,,,,,"@link KVStoreSerializer

Showing the first 1,200 of 5131 lines. Download the file for the rest.