HBASE-12024 Fix javadoc warning.
This commit is contained in:
parent
7e6cb56e4c
commit
0834770e63
@ -36,7 +36,6 @@ import org.apache.hadoop.hbase.security.UserProvider;
|
|||||||
* From this {@link Connection} {@link Table} implementations are retrieved
|
* From this {@link Connection} {@link Table} implementations are retrieved
|
||||||
* with {@link Connection#getTable(TableName)}. Example:
|
* with {@link Connection#getTable(TableName)}. Example:
|
||||||
* <pre>
|
* <pre>
|
||||||
* {@code
|
|
||||||
* Connection connection = ConnectionFactory.createConnection(config);
|
* Connection connection = ConnectionFactory.createConnection(config);
|
||||||
* Table table = connection.getTable(TableName.valueOf("table1"));
|
* Table table = connection.getTable(TableName.valueOf("table1"));
|
||||||
* try {
|
* try {
|
||||||
|
@ -34,7 +34,6 @@ import org.apache.hadoop.hbase.security.User;
|
|||||||
* From this {@link HConnection} {@link HTableInterface} implementations are retrieved
|
* From this {@link HConnection} {@link HTableInterface} implementations are retrieved
|
||||||
* with {@link HConnection#getTable(byte[])}. Example:
|
* with {@link HConnection#getTable(byte[])}. Example:
|
||||||
* <pre>
|
* <pre>
|
||||||
* {@code
|
|
||||||
* HConnection connection = HConnectionManager.createConnection(config);
|
* HConnection connection = HConnectionManager.createConnection(config);
|
||||||
* HTableInterface table = connection.getTable(TableName.valueOf("table1"));
|
* HTableInterface table = connection.getTable(TableName.valueOf("table1"));
|
||||||
* try {
|
* try {
|
||||||
@ -43,7 +42,7 @@ import org.apache.hadoop.hbase.security.User;
|
|||||||
* table.close();
|
* table.close();
|
||||||
* connection.close();
|
* connection.close();
|
||||||
* }
|
* }
|
||||||
* }</pre>
|
* </pre>
|
||||||
* <p>This class has a static Map of {@link HConnection} instances keyed by
|
* <p>This class has a static Map of {@link HConnection} instances keyed by
|
||||||
* {@link HConnectionKey}; A {@link HConnectionKey} is identified by a set of
|
* {@link HConnectionKey}; A {@link HConnectionKey} is identified by a set of
|
||||||
* {@link Configuration} properties. Invocations of {@link #getConnection(Configuration)}
|
* {@link Configuration} properties. Invocations of {@link #getConnection(Configuration)}
|
||||||
@ -125,7 +124,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* calling {@link HConnection#close()} on the returned connection instance.
|
* calling {@link HConnection#close()} on the returned connection instance.
|
||||||
*
|
*
|
||||||
* This is the recommended way to create HConnections.
|
* This is the recommended way to create HConnections.
|
||||||
* {@code
|
* <pre>
|
||||||
* HConnection connection = HConnectionManager.createConnection(conf);
|
* HConnection connection = HConnectionManager.createConnection(conf);
|
||||||
* HTableInterface table = connection.getTable("mytable");
|
* HTableInterface table = connection.getTable("mytable");
|
||||||
* try {
|
* try {
|
||||||
@ -135,6 +134,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* table.close();
|
* table.close();
|
||||||
* connection.close();
|
* connection.close();
|
||||||
* }
|
* }
|
||||||
|
* </pre>
|
||||||
*
|
*
|
||||||
* @param conf configuration
|
* @param conf configuration
|
||||||
* @return HConnection object for <code>conf</code>
|
* @return HConnection object for <code>conf</code>
|
||||||
@ -152,7 +152,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* {@link #getConnection(Configuration)}. The caller is responsible for
|
* {@link #getConnection(Configuration)}. The caller is responsible for
|
||||||
* calling {@link HConnection#close()} on the returned connection instance.
|
* calling {@link HConnection#close()} on the returned connection instance.
|
||||||
* This is the recommended way to create HConnections.
|
* This is the recommended way to create HConnections.
|
||||||
* {@code
|
* <pre>
|
||||||
* ExecutorService pool = ...;
|
* ExecutorService pool = ...;
|
||||||
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
||||||
* HTableInterface table = connection.getTable("mytable");
|
* HTableInterface table = connection.getTable("mytable");
|
||||||
@ -160,7 +160,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* ...
|
* ...
|
||||||
* table.close();
|
* table.close();
|
||||||
* connection.close();
|
* connection.close();
|
||||||
* }
|
* </pre>
|
||||||
* @param conf configuration
|
* @param conf configuration
|
||||||
* @param pool the thread pool to use for batch operation in HTables used via this HConnection
|
* @param pool the thread pool to use for batch operation in HTables used via this HConnection
|
||||||
* @return HConnection object for <code>conf</code>
|
* @return HConnection object for <code>conf</code>
|
||||||
@ -178,7 +178,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* {@link #getConnection(Configuration)}. The caller is responsible for
|
* {@link #getConnection(Configuration)}. The caller is responsible for
|
||||||
* calling {@link HConnection#close()} on the returned connection instance.
|
* calling {@link HConnection#close()} on the returned connection instance.
|
||||||
* This is the recommended way to create HConnections.
|
* This is the recommended way to create HConnections.
|
||||||
* {@code
|
* <pre>
|
||||||
* ExecutorService pool = ...;
|
* ExecutorService pool = ...;
|
||||||
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
||||||
* HTableInterface table = connection.getTable("mytable");
|
* HTableInterface table = connection.getTable("mytable");
|
||||||
@ -186,7 +186,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* ...
|
* ...
|
||||||
* table.close();
|
* table.close();
|
||||||
* connection.close();
|
* connection.close();
|
||||||
* }
|
* </pre>
|
||||||
* @param conf configuration
|
* @param conf configuration
|
||||||
* @param user the user the connection is for
|
* @param user the user the connection is for
|
||||||
* @return HConnection object for <code>conf</code>
|
* @return HConnection object for <code>conf</code>
|
||||||
@ -204,7 +204,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* {@link #getConnection(Configuration)}. The caller is responsible for
|
* {@link #getConnection(Configuration)}. The caller is responsible for
|
||||||
* calling {@link HConnection#close()} on the returned connection instance.
|
* calling {@link HConnection#close()} on the returned connection instance.
|
||||||
* This is the recommended way to create HConnections.
|
* This is the recommended way to create HConnections.
|
||||||
* {@code
|
* <pre>
|
||||||
* ExecutorService pool = ...;
|
* ExecutorService pool = ...;
|
||||||
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
* HConnection connection = HConnectionManager.createConnection(conf, pool);
|
||||||
* HTableInterface table = connection.getTable("mytable");
|
* HTableInterface table = connection.getTable("mytable");
|
||||||
@ -212,7 +212,7 @@ public class HConnectionManager extends ConnectionFactory {
|
|||||||
* ...
|
* ...
|
||||||
* table.close();
|
* table.close();
|
||||||
* connection.close();
|
* connection.close();
|
||||||
* }
|
* </pre>
|
||||||
* @param conf configuration
|
* @param conf configuration
|
||||||
* @param pool the thread pool to use for batch operation in HTables used via this HConnection
|
* @param pool the thread pool to use for batch operation in HTables used via this HConnection
|
||||||
* @param user the user the connection is for
|
* @param user the user the connection is for
|
||||||
|
@ -61,7 +61,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
/**
|
/**
|
||||||
* Does NOT add a column family. This object is immutable
|
* Does NOT add a column family. This object is immutable
|
||||||
* @param family HColumnDescriptor of familyto add.
|
* @param family HColumnDescriptor of familyto add.
|
||||||
* @return
|
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public HTableDescriptor addFamily(final HColumnDescriptor family) {
|
public HTableDescriptor addFamily(final HColumnDescriptor family) {
|
||||||
@ -79,7 +78,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @see org.apache.hadoop.hbase.HTableDescriptor#setReadOnly(boolean)
|
* @see org.apache.hadoop.hbase.HTableDescriptor#setReadOnly(boolean)
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
@ -88,7 +86,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @see org.apache.hadoop.hbase.HTableDescriptor#setValue(byte[], byte[])
|
* @see org.apache.hadoop.hbase.HTableDescriptor#setValue(byte[], byte[])
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
@ -97,7 +94,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @see org.apache.hadoop.hbase.HTableDescriptor#setValue(java.lang.String, java.lang.String)
|
* @see org.apache.hadoop.hbase.HTableDescriptor#setValue(java.lang.String, java.lang.String)
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
@ -106,7 +102,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @see org.apache.hadoop.hbase.HTableDescriptor#setMaxFileSize(long)
|
* @see org.apache.hadoop.hbase.HTableDescriptor#setMaxFileSize(long)
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
@ -115,7 +110,6 @@ public class UnmodifyableHTableDescriptor extends HTableDescriptor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return
|
|
||||||
* @see org.apache.hadoop.hbase.HTableDescriptor#setMemStoreFlushSize(long)
|
* @see org.apache.hadoop.hbase.HTableDescriptor#setMemStoreFlushSize(long)
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
@ -24,8 +24,6 @@ import java.lang.reflect.UndeclaredThrowableException;
|
|||||||
import java.security.PrivilegedAction;
|
import java.security.PrivilegedAction;
|
||||||
import java.security.PrivilegedExceptionAction;
|
import java.security.PrivilegedExceptionAction;
|
||||||
|
|
||||||
import org.apache.commons.logging.Log;
|
|
||||||
import org.apache.commons.logging.LogFactory;
|
|
||||||
import org.apache.hadoop.classification.InterfaceAudience;
|
import org.apache.hadoop.classification.InterfaceAudience;
|
||||||
import org.apache.hadoop.conf.Configuration;
|
import org.apache.hadoop.conf.Configuration;
|
||||||
import org.apache.hadoop.hbase.util.Methods;
|
import org.apache.hadoop.hbase.util.Methods;
|
||||||
@ -51,8 +49,6 @@ public abstract class User {
|
|||||||
public static final String HBASE_SECURITY_CONF_KEY =
|
public static final String HBASE_SECURITY_CONF_KEY =
|
||||||
"hbase.security.authentication";
|
"hbase.security.authentication";
|
||||||
|
|
||||||
private static Log LOG = LogFactory.getLog(User.class);
|
|
||||||
|
|
||||||
protected UserGroupInformation ugi;
|
protected UserGroupInformation ugi;
|
||||||
|
|
||||||
public UserGroupInformation getUGI() {
|
public UserGroupInformation getUGI() {
|
||||||
@ -167,7 +163,7 @@ public abstract class User {
|
|||||||
/**
|
/**
|
||||||
* Executes the given action as the login user
|
* Executes the given action as the login user
|
||||||
* @param action
|
* @param action
|
||||||
* @return
|
* @return the result of the action
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
* @throws InterruptedException
|
* @throws InterruptedException
|
||||||
*/
|
*/
|
||||||
|
Loading…
x
Reference in New Issue
Block a user