Author: remm
Date: Thu Jan 14 14:55:44 2016
New Revision: 1724626
URL: http://svn.apache.org/viewvc?rev=1724626&view=rev
Log:
Javadoc fixes.
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/ByteMessage.java
tomcat/trunk/java/org/apache/catalina/tribes/Channel.java
tomcat/trunk/java/org/apache/catalina/tribes/ChannelException.java
tomcat/trunk/java/org/apache/catalina/tribes/ChannelInterceptor.java
tomcat/trunk/java/org/apache/catalina/tribes/ChannelReceiver.java
tomcat/trunk/java/org/apache/catalina/tribes/Member.java
tomcat/trunk/java/org/apache/catalina/tribes/MembershipService.java
tomcat/trunk/java/org/apache/catalina/tribes/group/GroupChannel.java
tomcat/trunk/java/org/apache/catalina/tribes/group/RpcCallback.java
tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/GzipInterceptor.java
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/SimpleCoordinator.java
tomcat/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
tomcat/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastService.java
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastServiceImpl.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/RxTaskPool.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReplicationTask.java
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
tomcat/trunk/java/org/apache/catalina/users/MemoryUser.java
tomcat/trunk/java/org/apache/catalina/users/MemoryUserDatabase.java
tomcat/trunk/java/org/apache/catalina/util/CharsetMapper.java
tomcat/trunk/java/org/apache/catalina/util/DOMWriter.java
tomcat/trunk/java/org/apache/catalina/util/Extension.java
tomcat/trunk/java/org/apache/catalina/util/ExtensionValidator.java
tomcat/trunk/java/org/apache/catalina/util/IOTools.java
tomcat/trunk/java/org/apache/catalina/util/Introspection.java
tomcat/trunk/java/org/apache/catalina/util/MIME2Java.java
tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java
tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java
tomcat/trunk/java/org/apache/catalina/util/ServerInfo.java
tomcat/trunk/java/org/apache/catalina/util/SessionConfig.java
tomcat/trunk/java/org/apache/catalina/util/Strftime.java
tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java
tomcat/trunk/java/org/apache/catalina/valves/AbstractAccessLogValve.java
tomcat/trunk/java/org/apache/catalina/valves/AccessLogValve.java
tomcat/trunk/java/org/apache/catalina/valves/ErrorReportValve.java
tomcat/trunk/java/org/apache/catalina/valves/JDBCAccessLogValve.java
tomcat/trunk/java/org/apache/catalina/valves/PersistentValve.java
tomcat/trunk/java/org/apache/catalina/valves/RemoteAddrValve.java
tomcat/trunk/java/org/apache/catalina/valves/RemoteHostValve.java
tomcat/trunk/java/org/apache/catalina/valves/RemoteIpValve.java
tomcat/trunk/java/org/apache/catalina/valves/RequestFilterValve.java
tomcat/trunk/java/org/apache/catalina/valves/SemaphoreValve.java
tomcat/trunk/java/org/apache/catalina/valves/rewrite/RewriteCond.java
tomcat/trunk/java/org/apache/catalina/valves/rewrite/RewriteRule.java
tomcat/trunk/java/org/apache/catalina/valves/rewrite/RewriteValve.java
tomcat/trunk/java/org/apache/catalina/valves/rewrite/Substitution.java
tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java
Modified: tomcat/trunk/java/org/apache/catalina/tribes/ByteMessage.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/ByteMessage.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/ByteMessage.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/ByteMessage.java Thu Jan 14
14:55:44 2016
@@ -77,7 +77,7 @@ public class ByteMessage implements Exte
/**
* @see java.io.Externalizable#readExternal
* @param in ObjectInput
- * @throws IOException
+ * @throws IOException An IO error occurred
*/
@Override
public void readExternal(ObjectInput in ) throws IOException {
@@ -89,7 +89,7 @@ public class ByteMessage implements Exte
/**
* @see java.io.Externalizable#writeExternal
* @param out ObjectOutput
- * @throws IOException
+ * @throws IOException An IO error occurred
*/
@Override
public void writeExternal(ObjectOutput out) throws IOException {
Modified: tomcat/trunk/java/org/apache/catalina/tribes/Channel.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/Channel.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/Channel.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/Channel.java Thu Jan 14
14:55:44 2016
@@ -253,6 +253,7 @@ public interface Channel {
* send a pure byte array
* @param options int - sender options, see class documentation for each
interceptor that is configured in order to trigger interceptors
* @return a unique Id that identifies the message that is sent
+ * @throws ChannelException if a serialization error happens.
* @see ByteMessage
* @see #SEND_OPTIONS_USE_ACK
* @see #SEND_OPTIONS_ASYNCHRONOUS
Modified: tomcat/trunk/java/org/apache/catalina/tribes/ChannelException.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/ChannelException.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/ChannelException.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/ChannelException.java Thu Jan
14 14:55:44 2016
@@ -33,7 +33,7 @@ public class ChannelException extends Ex
* Empty list to avoid reinstatiating lists
*/
protected static final FaultyMember[] EMPTY_LIST = new FaultyMember[0];
- /*
+ /**
* Holds a list of faulty members
*/
private ArrayList<FaultyMember> faultyMembers=null;
@@ -48,6 +48,7 @@ public class ChannelException extends Ex
/**
* Constructor, creates a ChannelException with an error message
+ * @param message The error message
* @see java.lang.Exception#Exception(String)
*/
public ChannelException(String message) {
@@ -56,7 +57,7 @@ public class ChannelException extends Ex
/**
* Constructor, creates a ChannelException with an error message and a
cause
- * @param message String
+ * @param message The error message
* @param cause Throwable
* @see java.lang.Exception#Exception(String,Throwable)
*/
@@ -75,7 +76,7 @@ public class ChannelException extends Ex
/**
* Returns the message for this exception
- * @return String
+ * @return the error message
* @see java.lang.Exception#getMessage()
*/
@Override
@@ -98,6 +99,7 @@ public class ChannelException extends Ex
* Adds a faulty member, and the reason the member failed.
* @param mbr Member
* @param x Exception
+ * @return <code>true</code> if the member was added
*/
public boolean addFaultyMember(Member mbr, Exception x ) {
return addFaultyMember(new FaultyMember(mbr,x));
@@ -106,6 +108,7 @@ public class ChannelException extends Ex
/**
* Adds a list of faulty members
* @param mbrs FaultyMember[]
+ * @return the number of members added
*/
public int addFaultyMember(FaultyMember[] mbrs) {
int result = 0;
@@ -118,6 +121,7 @@ public class ChannelException extends Ex
/**
* Adds a faulty member
* @param mbr FaultyMember
+ * @return <code>true</code> if the member was added
*/
public boolean addFaultyMember(FaultyMember mbr) {
if ( this.faultyMembers==null ) this.faultyMembers = new ArrayList<>();
Modified: tomcat/trunk/java/org/apache/catalina/tribes/ChannelInterceptor.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/ChannelInterceptor.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/ChannelInterceptor.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/ChannelInterceptor.java Thu
Jan 14 14:55:44 2016
@@ -86,7 +86,7 @@ public interface ChannelInterceptor exte
* @param destination Member[] - the destination for this message
* @param msg ChannelMessage - the message to be sent
* @param payload InterceptorPayload - the payload, carrying an error
handler and future useful data, can be null
- * @throws ChannelException
+ * @throws ChannelException if a serialization error happens.
* @see ErrorHandler
* @see InterceptorPayload
*/
Modified: tomcat/trunk/java/org/apache/catalina/tribes/ChannelReceiver.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/ChannelReceiver.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/ChannelReceiver.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/ChannelReceiver.java Thu Jan
14 14:55:44 2016
@@ -29,7 +29,7 @@ public interface ChannelReceiver extends
/**
* Start listening for incoming messages on the host/port
- * @throws java.io.IOException
+ * @throws java.io.IOException Listen failed
*/
public void start() throws java.io.IOException;
Modified: tomcat/trunk/java/org/apache/catalina/tribes/Member.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/Member.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/Member.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/Member.java Thu Jan 14
14:55:44 2016
@@ -36,7 +36,7 @@ public interface Member {
public static final byte[] SHUTDOWN_PAYLOAD = new byte[] {66, 65, 66, 89,
45, 65, 76, 69, 88};
/**
- * Returns the name of this node, should be unique within the group.
+ * @return the name of this node, should be unique within the group.
*/
public String getName();
@@ -129,6 +129,7 @@ public interface Member {
* Highly optimized version of serializing a member into a byte array
* Returns a cached byte[] reference, do not modify this data
* @param getalive calculate memberAlive time
+ * @return the data as a byte array
*/
public byte[] getData(boolean getalive);
@@ -137,12 +138,14 @@ public interface Member {
* Returns a cached byte[] reference, do not modify this data
* @param getalive calculate memberAlive time
* @param reset reset the cached data package, and create a new one
+ * @return the data as a byte array
*/
public byte[] getData(boolean getalive, boolean reset);
/**
* Length of a message obtained by {@link #getData(boolean)} or
* {@link #getData(boolean, boolean)}.
+ * @return the data length
*/
public int getDataLength();
}
Modified: tomcat/trunk/java/org/apache/catalina/tribes/MembershipService.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/MembershipService.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/MembershipService.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/MembershipService.java Thu Jan
14 14:55:44 2016
@@ -35,10 +35,12 @@ public interface MembershipService {
* @param properties - to be used to configure the membership service.
*/
public void setProperties(java.util.Properties properties);
+
/**
- * Returns the properties for the configuration used.
+ * @return the properties for the configuration used.
*/
public java.util.Properties getProperties();
+
/**
* Starts the membership service. If a membership listeners is added
* the listener will start to receive membership events.
@@ -65,7 +67,6 @@ public interface MembershipService {
* stops broad casting the server
* @throws java.lang.IllegalArgumentException if the level is incorrect.
*/
-
public void stop(int level);
/**
@@ -73,36 +74,45 @@ public interface MembershipService {
*/
public boolean hasMembers();
-
/**
- *
- * @param mbr Member
- * @return Member
+ * Retrieve the specified member from the membership.
+ * @param mbr The member to retrieve
+ * @return the member
*/
public Member getMember(Member mbr);
+
/**
- * Returns a list of all the members in the cluster.
+ * @return a list of all the members in the cluster.
*/
-
public Member[] getMembers();
/**
- * Returns the member object that defines this member
+ * Get the local member.
+ * @return the member object that defines this member
+ * @param incAliveTime <code>true</code> to set the alive time
+ * on the local member
*/
public Member getLocalMember(boolean incAliveTime);
/**
- * Return all members by name
+ * @return all members by name
*/
- public String[] getMembersByName() ;
+ public String[] getMembersByName();
/**
- * Return the member by name
+ * Get a member.
+ * @param name The member name
+ * @return the member
*/
- public Member findMemberByName(String name) ;
+ public Member findMemberByName(String name);
/**
- * Sets the local member properties for broadcasting
+ * Sets the local member properties for broadcasting.
+ *
+ * @param listenHost Listen to host
+ * @param listenPort Listen to port
+ * @param securePort Use a secure port
+ * @param udpPort Use UDP
*/
public void setLocalMemberProperties(String listenHost, int listenPort,
int securePort, int udpPort);
@@ -114,7 +124,7 @@ public interface MembershipService {
public void setMembershipListener(MembershipListener listener);
/**
- * removes the membership listener.
+ * Removes the membership listener.
*/
public void removeMembershipListener();
@@ -128,9 +138,9 @@ public interface MembershipService {
public void setDomain(byte[] domain);
/**
- * Broadcasts a message to all members
- * @param message
- * @throws ChannelException
+ * Broadcasts a message to all members.
+ * @param message The message to broadcast
+ * @throws ChannelException Message broadcast failed
*/
public void broadcast(ChannelMessage message) throws ChannelException;
Modified: tomcat/trunk/java/org/apache/catalina/tribes/group/GroupChannel.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/GroupChannel.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/group/GroupChannel.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/group/GroupChannel.java Thu
Jan 14 14:55:44 2016
@@ -367,7 +367,7 @@ public class GroupChannel extends Channe
/**
* Sets up the default implementation interceptor stack
* if no interceptors have been added
- * @throws ChannelException
+ * @throws ChannelException Cluster error
*/
protected synchronized void setupDefaultStack() throws ChannelException {
if (getFirstInterceptor() != null &&
@@ -379,7 +379,7 @@ public class GroupChannel extends Channe
/**
* Validates the option flags that each interceptor is using and reports
* an error if two interceptor share the same flag.
- * @throws ChannelException
+ * @throws ChannelException Error with option flag
*/
protected void checkOptionFlags() throws ChannelException {
StringBuilder conflicts = new StringBuilder();
@@ -412,9 +412,9 @@ public class GroupChannel extends Channe
}
/**
- * Starts the channel
+ * Starts the channel.
* @param svc int - what service to start
- * @throws ChannelException
+ * @throws ChannelException Start error
* @see org.apache.catalina.tribes.Channel#start(int)
*/
@Override
@@ -429,9 +429,9 @@ public class GroupChannel extends Channe
}
/**
- * Stops the channel
+ * Stops the channel.
* @param svc int
- * @throws ChannelException
+ * @throws ChannelException Stop error
* @see org.apache.catalina.tribes.Channel#stop(int)
*/
@Override
Modified: tomcat/trunk/java/org/apache/catalina/tribes/group/RpcCallback.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/RpcCallback.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/group/RpcCallback.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/group/RpcCallback.java Thu Jan
14 14:55:44 2016
@@ -28,16 +28,17 @@ import org.apache.catalina.tribes.Member
public interface RpcCallback {
/**
- *
- * @param msg Serializable
- * @return Serializable - null if no reply should be sent
+ * Allows sending a response to a recieved message.
+ * @param msg The message
+ * @param sender Member
+ * @return Serializable object, <code>null</code> if no reply should be
sent
*/
public Serializable replyRequest(Serializable msg, Member sender);
/**
* If the reply has already been sent to the requesting thread,
* the rpc callback can handle any data that comes in after the fact.
- * @param msg Serializable
+ * @param msg The message
* @param sender Member
*/
public void leftOver(Serializable msg, Member sender);
Modified: tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java Thu Jan
14 14:55:44 2016
@@ -75,7 +75,7 @@ public class RpcChannel implements Chann
* @param channelOptions channel sender options
* @param timeout long - timeout in milliseconds, if no reply is received
within this time null is returned
* @return Response[] - an array of response objects.
- * @throws ChannelException
+ * @throws ChannelException Error sending message
*/
public Response[] send(Member[] destination,
Serializable message,
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/GzipInterceptor.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/GzipInterceptor.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/GzipInterceptor.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/GzipInterceptor.java
Thu Jan 14 14:55:44 2016
@@ -80,7 +80,7 @@ public class GzipInterceptor extends Cha
/**
* @param data Data to decompress
* @return Decompressed data
- * @throws IOException
+ * @throws IOException Compression error
*/
public static byte[] decompress(byte[] data) throws IOException {
ByteArrayOutputStream bout =
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/SimpleCoordinator.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/SimpleCoordinator.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/SimpleCoordinator.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/group/interceptors/SimpleCoordinator.java
Thu Jan 14 14:55:44 2016
@@ -58,7 +58,7 @@ public class SimpleCoordinator extends C
/**
* Override to receive view changes.
*
- * @param view
+ * @param view The members array
*/
protected void viewChange(final Member[] view) {
}
Modified: tomcat/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/io/ObjectReader.java Thu Jan
14 14:55:44 2016
@@ -93,9 +93,8 @@ public class ObjectReader {
* @param len length in buffer
* @param count whether to return the count
* @return number of messages that was sent to callback (or -1 if count ==
false)
- * @throws java.io.IOException
*/
- public int append(ByteBuffer data, int len, boolean count) throws
java.io.IOException {
+ public int append(ByteBuffer data, int len, boolean count) {
buffer.append(data,len);
int pkgCnt = -1;
if ( count ) pkgCnt = buffer.countPackages();
@@ -118,9 +117,8 @@ public class ObjectReader {
* @see XByteBuffer#extractPackage(boolean)
*
* @return number of received packages/messages
- * @throws java.io.IOException
*/
- public ChannelMessage[] execute() throws java.io.IOException {
+ public ChannelMessage[] execute() {
int pkgCnt = buffer.countPackages();
ChannelMessage[] result = new ChannelMessage[pkgCnt];
for (int i=0; i<pkgCnt; i++) {
Modified: tomcat/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/io/XByteBuffer.java Thu Jan 14
14:55:44 2016
@@ -84,7 +84,8 @@ public class XByteBuffer {
/**
* Constructs a new XByteBuffer.<br>
* TODO use a pool of byte[] for performance
- * @param size - the initial size of the byte buffer
+ * @param size the initial size of the byte buffer
+ * @param discard Flag for discarding invalid packages
*/
public XByteBuffer(int size, boolean discard) {
buf = new byte[size];
@@ -128,7 +129,7 @@ public class XByteBuffer {
}
/**
- * Returns the bytes in the buffer, in its exact length
+ * @return the bytes in the buffer, in its exact length
*/
public byte[] getBytes() {
byte[] b = new byte[bufSize];
@@ -392,7 +393,6 @@ public class XByteBuffer {
* @param b - the byte array containing the four bytes
* @param off - the offset
* @return the integer value constructed from the four bytes
- * @exception java.lang.ArrayIndexOutOfBoundsException
*/
public static int toInt(byte[] b,int off){
return ( ( b[off+3]) & 0xFF) +
@@ -406,7 +406,6 @@ public class XByteBuffer {
* @param b - the byte array containing the four bytes
* @param off - the offset
* @return the long value constructed from the eight bytes
- * @exception java.lang.ArrayIndexOutOfBoundsException
*/
public static long toLong(byte[] b,int off){
return ( ( (long) b[off+7]) & 0xFF) +
@@ -421,9 +420,11 @@ public class XByteBuffer {
/**
- * Converts a boolean to a 1-byte array
- * @param bool - the integer
- * @return - 1-byte array
+ * Converts a boolean and put it in a byte array.
+ * @param bool the integer
+ * @param data the byte buffer in which the boolean will be placed
+ * @param offset the offset in the byte array
+ * @return the byte array
*/
public static byte[] toBytes(boolean bool, byte[] data, int offset) {
data[offset] = (byte)(bool?1:0);
@@ -431,7 +432,7 @@ public class XByteBuffer {
}
/**
- * Converts a byte array entry to boolean
+ * Converts a byte array entry to boolean.
* @param b byte array
* @param offset within byte array
* @return true if byte array entry is non-zero, false otherwise
@@ -442,11 +443,13 @@ public class XByteBuffer {
/**
- * Converts an integer to four bytes
- * @param n - the integer
- * @return - four bytes in an array
+ * Converts an integer to four bytes.
+ * @param n the integer
+ * @param b the byte buffer in which the integer will be placed
+ * @param offset the offset in the byte array
+ * @return four bytes in an array
*/
- public static byte[] toBytes(int n,byte[] b, int offset) {
+ public static byte[] toBytes(int n, byte[] b, int offset) {
b[offset+3] = (byte) (n);
n >>>= 8;
b[offset+2] = (byte) (n);
@@ -458,9 +461,11 @@ public class XByteBuffer {
}
/**
- * Converts an long to eight bytes
- * @param n - the long
- * @return - eight bytes in an array
+ * Converts an long to eight bytes.
+ * @param n the long
+ * @param b the byte buffer in which the integer will be placed
+ * @param offset the offset in the byte array
+ * @return eight bytes in an array
*/
public static byte[] toBytes(long n, byte[] b, int offset) {
b[offset+7] = (byte) (n);
@@ -482,7 +487,7 @@ public class XByteBuffer {
}
/**
- * Similar to a String.IndexOf, but uses pure bytes
+ * Similar to a String.IndexOf, but uses pure bytes.
* @param src - the source bytes to be searched
* @param srcOff - offset on the source buffer
* @param find - the string to be found within src
@@ -567,7 +572,7 @@ public class XByteBuffer {
* Serializes a message into cluster data
* @param msg ClusterMessage
* @return serialized content as byte[] array
- * @throws IOException
+ * @throws IOException Serialization error
*/
public static byte[] serialize(Serializable msg) throws IOException {
ByteArrayOutputStream outs = new ByteArrayOutputStream();
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastService.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/membership/McastService.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/membership/McastService.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/membership/McastService.java
Thu Jan 14 14:55:44 2016
@@ -91,7 +91,7 @@ public class McastService implements Mem
}
/**
- *
+ * Sets the properties for the membership service.
* @param properties
* <br>All are required<br>
* 1. mcastPort - the port to listen to<BR>
@@ -115,7 +115,7 @@ public class McastService implements Mem
}
/**
- * Return the properties, see setProperties
+ * {@inheritDoc}
*/
@Override
public Properties getProperties() {
@@ -123,14 +123,14 @@ public class McastService implements Mem
}
/**
- * Return the local member name
+ * @return the local member name
*/
public String getLocalMemberName() {
return localMember.toString() ;
}
/**
- * Return the local member
+ * {@inheritDoc}
*/
@Override
public Member getLocalMember(boolean alive) {
@@ -139,7 +139,7 @@ public class McastService implements Mem
}
/**
- * Sets the local member properties for broadcasting
+ * {@inheritDoc}
*/
@Override
public void setLocalMemberProperties(String listenHost, int listenPort,
int securePort, int udpPort) {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastServiceImpl.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/membership/McastServiceImpl.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastServiceImpl.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/membership/McastServiceImpl.java
Thu Jan 14 14:55:44 2016
@@ -156,16 +156,19 @@ public class McastServiceImpl {
protected final boolean localLoopbackDisabled;
/**
- * Create a new mcast service impl
+ * Create a new mcast service instance.
* @param member - the local member
* @param sendFrequency - the time (ms) in between pings sent out
* @param expireTime - the time (ms) for a member to expire
* @param port - the mcast port
* @param bind - the bind address (not sure this is used yet)
* @param mcastAddress - the mcast address
+ * @param ttl multicast ttl that will be set on the socket
+ * @param soTimeout Socket timeout
* @param service - the callback service
+ * @param msgservice Message listener
* @param localLoopbackDisabled - disable loopbackMode
- * @throws IOException
+ * @throws IOException Init error
*/
public McastServiceImpl(
MemberImpl member,
@@ -298,7 +301,9 @@ public class McastServiceImpl {
}
/**
- * Stops the service
+ * Stops the service.
+ * @param level Stop status
+ * @return <code>true</code> if the stop is complete
* @throws IOException if the service fails to disconnect from the sockets
*/
public synchronized boolean stop(int level) throws IOException {
@@ -336,7 +341,7 @@ public class McastServiceImpl {
/**
* Receive a datagram packet, locking wait
- * @throws IOException
+ * @throws IOException Received failed
*/
public void receive() throws IOException {
boolean checkexpired = true;
@@ -477,16 +482,17 @@ public class McastServiceImpl {
}
/**
- * Send a ping
- * @throws IOException
+ * Send a ping.
+ * @param checkexpired <code>true</code> to check for expiration
+ * @throws IOException Send error
*/
- public void send(boolean checkexpired) throws IOException{
+ public void send(boolean checkexpired) throws IOException {
send(checkexpired,null);
}
private final Object sendLock = new Object();
- public void send(boolean checkexpired, DatagramPacket packet) throws
IOException{
+ public void send(boolean checkexpired, DatagramPacket packet) throws
IOException {
checkexpired = (checkexpired && (packet==null));
//ignore if we haven't started the sender
//if ( (startLevel&Channel.MBR_TX_SEQ) != Channel.MBR_TX_SEQ ) return;
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java
Thu Jan 14 14:55:44 2016
@@ -156,12 +156,14 @@ public abstract class AbstractReplicated
//------------------------------------------------------------------------------
/**
- * Creates a new map
+ * Creates a new map.
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
* @param initialCapacity int - the size of this map, see HashMap
* @param loadFactor float - load factor, see HashMap
+ * @param channelSendOptions Send options
* @param cls - a list of classloaders to be used for deserialization of
objects.
* @param terminate - Flag for whether to terminate this map that failed
to start.
*/
@@ -248,7 +250,7 @@ public abstract class AbstractReplicated
* Sends a ping out to all the members in the cluster, not just map members
* that this map is alive.
* @param timeout long
- * @throws ChannelException
+ * @throws ChannelException Send error
*/
protected void ping(long timeout) throws ChannelException {
//send out a map membership message, only wait for the first reply
@@ -307,7 +309,7 @@ public abstract class AbstractReplicated
* Helper method to broadcast a message to all members in a channel
* @param msgtype int
* @param rpc boolean
- * @throws ChannelException
+ * @throws ChannelException Send error
*/
protected void broadcast(int msgtype, boolean rpc) throws ChannelException
{
Member[] members = channel.getMembers();
@@ -400,6 +402,7 @@ public abstract class AbstractReplicated
/**
* Replicates any changes to the object since the last time
* The object has to be primary, ie, if the object is a proxy or a backup,
it will not be replicated<br>
+ * @param key The object to replicate
* @param complete - if set to true, the object is replicated to its backup
* if set to false, only objects that implement ReplicatedMapEntry and the
isDirty() returns true will
* be replicated
@@ -1301,8 +1304,8 @@ public abstract class AbstractReplicated
* @param offset int
* @param length int
* @param diff boolean
- * @throws IOException
- * @throws ClassNotFoundException
+ * @throws IOException IO error
+ * @throws ClassNotFoundException Deserialization error
*/
@SuppressWarnings("unchecked")
public void apply(byte[] data, int offset, int length, boolean diff)
throws IOException, ClassNotFoundException {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/tipis/LazyReplicatedMap.java
Thu Jan 14 14:55:44 2016
@@ -72,11 +72,13 @@ public class LazyReplicatedMap<K,V> exte
//------------------------------------------------------------------------------
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
* @param initialCapacity int - the size of this map, see HashMap
* @param loadFactor float - load factor, see HashMap
+ * @param cls Class loaders
*/
public LazyReplicatedMap(MapOwner owner, Channel channel, long timeout,
String mapContextName, int initialCapacity, float loadFactor, ClassLoader[]
cls) {
super(owner,channel,timeout,mapContextName,initialCapacity,loadFactor,
Channel.SEND_OPTIONS_DEFAULT,cls, true);
@@ -84,10 +86,12 @@ public class LazyReplicatedMap<K,V> exte
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
* @param initialCapacity int - the size of this map, see HashMap
+ * @param cls Class loaders
*/
public LazyReplicatedMap(MapOwner owner, Channel channel, long timeout,
String mapContextName, int initialCapacity, ClassLoader[] cls) {
super(owner, channel,timeout,mapContextName,initialCapacity,
AbstractReplicatedMap.DEFAULT_LOAD_FACTOR, Channel.SEND_OPTIONS_DEFAULT, cls,
true);
@@ -95,9 +99,11 @@ public class LazyReplicatedMap<K,V> exte
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
+ * @param cls Class loaders
*/
public LazyReplicatedMap(MapOwner owner, Channel channel, long timeout,
String mapContextName, ClassLoader[] cls) {
super(owner, channel,timeout,mapContextName,
AbstractReplicatedMap.DEFAULT_INITIAL_CAPACITY,AbstractReplicatedMap.DEFAULT_LOAD_FACTOR,Channel.SEND_OPTIONS_DEFAULT,
cls, true);
@@ -105,9 +111,11 @@ public class LazyReplicatedMap<K,V> exte
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
+ * @param cls Class loaders
* @param terminate boolean - Flag for whether to terminate this map that
failed to start.
*/
public LazyReplicatedMap(MapOwner owner, Channel channel, long timeout,
String mapContextName, ClassLoader[] cls, boolean terminate) {
@@ -134,7 +142,7 @@ public class LazyReplicatedMap<K,V> exte
* @param key Object
* @param value Object
* @return Member - the backup node
- * @throws ChannelException
+ * @throws ChannelException Cluster error
*/
@Override
protected Member[] publishEntryInfo(Object key, Object value) throws
ChannelException {
Modified: tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/tipis/ReplicatedMap.java Thu
Jan 14 14:55:44 2016
@@ -64,11 +64,13 @@ public class ReplicatedMap<K,V> extends
//--------------------------------------------------------------------------
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
* @param initialCapacity int - the size of this map, see HashMap
* @param loadFactor float - load factor, see HashMap
+ * @param cls Class loaders
*/
public ReplicatedMap(MapOwner owner, Channel channel, long timeout, String
mapContextName, int initialCapacity,float loadFactor, ClassLoader[] cls) {
super(owner,channel, timeout, mapContextName, initialCapacity,
loadFactor, Channel.SEND_OPTIONS_DEFAULT, cls, true);
@@ -76,10 +78,12 @@ public class ReplicatedMap<K,V> extends
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
* @param initialCapacity int - the size of this map, see HashMap
+ * @param cls Class loaders
*/
public ReplicatedMap(MapOwner owner, Channel channel, long timeout, String
mapContextName, int initialCapacity, ClassLoader[] cls) {
super(owner,channel, timeout, mapContextName, initialCapacity,
AbstractReplicatedMap.DEFAULT_LOAD_FACTOR,Channel.SEND_OPTIONS_DEFAULT, cls,
true);
@@ -87,9 +91,11 @@ public class ReplicatedMap<K,V> extends
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
+ * @param cls Class loaders
*/
public ReplicatedMap(MapOwner owner, Channel channel, long timeout, String
mapContextName, ClassLoader[] cls) {
super(owner, channel, timeout,
mapContextName,AbstractReplicatedMap.DEFAULT_INITIAL_CAPACITY,
AbstractReplicatedMap.DEFAULT_LOAD_FACTOR, Channel.SEND_OPTIONS_DEFAULT, cls,
true);
@@ -97,9 +103,11 @@ public class ReplicatedMap<K,V> extends
/**
* Creates a new map
+ * @param owner The map owner
* @param channel The channel to use for communication
* @param timeout long - timeout for RPC messags
* @param mapContextName String - unique name for this map, to allow
multiple maps per channel
+ * @param cls Class loaders
* @param terminate boolean - Flag for whether to terminate this map that
failed to start.
*/
public ReplicatedMap(MapOwner owner, Channel channel, long timeout, String
mapContextName, ClassLoader[] cls, boolean terminate) {
@@ -125,7 +133,7 @@ public class ReplicatedMap<K,V> extends
* @param key Object
* @param value Object
* @return Member - the backup node
- * @throws ChannelException
+ * @throws ChannelException Cluster error
*/
@Override
protected Member[] publishEntryInfo(Object key, Object value) throws
ChannelException {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/transport/ReceiverBase.java
Thu Jan 14 14:55:44 2016
@@ -175,7 +175,7 @@ public abstract class ReceiverBase imple
* @param portstart Starting port for bind attempts
* @param retries Number of times to attempt to bind (port
incremented
* between attempts)
- * @throws IOException
+ * @throws IOException Socket bind error
*/
protected void bind(ServerSocket socket, int portstart, int retries)
throws IOException {
synchronized (bindLock) {
@@ -202,11 +202,12 @@ public abstract class ReceiverBase imple
/**
* Same as bind() except it does it for the UDP port
- * @param socket
- * @param portstart
- * @param retries
- * @return int
- * @throws IOException
+ * @param socket The socket to bind
+ * @param portstart Starting port for bind attempts
+ * @param retries Number of times to attempt to bind (port
incremented
+ * between attempts)
+ * @return int The retry count
+ * @throws IOException Socket bind error
*/
protected int bindUdp(DatagramSocket socket, int portstart, int retries)
throws IOException {
InetSocketAddress addr = null;
Modified: tomcat/trunk/java/org/apache/catalina/tribes/transport/RxTaskPool.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/RxTaskPool.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/transport/RxTaskPool.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/transport/RxTaskPool.java Thu
Jan 14 14:55:44 2016
@@ -59,6 +59,7 @@ public class RxTaskPool {
/**
* Find an idle worker thread, if any. Could return null.
+ * @return a worker
*/
public AbstractRxTask getRxTask()
{
@@ -95,6 +96,7 @@ public class RxTaskPool {
/**
* Called by the worker thread to return itself to the
* idle pool.
+ * @param worker The worker
*/
public void returnWorker (AbstractRxTask worker) {
if ( running ) {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioReplicationTask.java
Thu Jan 14 14:55:44 2016
@@ -134,8 +134,9 @@ public class BioReplicationTask extends
* interest in OP_READ. When this method completes it
* re-enables OP_READ and calls wakeup() on the selector
* so the selector will resume watching this channel.
+ * @throws Exception IO exception or execute exception
*/
- protected void drainSocket () throws Exception {
+ protected void drainSocket() throws Exception {
InputStream in = socket.getInputStream();
// loop while data available, channel is non-blocking
byte[] buf = new byte[1024];
@@ -149,8 +150,8 @@ public class BioReplicationTask extends
/**
- * send a reply-acknowledgment (6,2,3)
- * @param command
+ * Send a reply-acknowledgment (6,2,3)
+ * @param command The command to write
*/
protected void sendAck(byte[] command) {
try {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/transport/bio/BioSender.java
Thu Jan 14 14:55:44 2016
@@ -99,6 +99,9 @@ public class BioSender extends AbstractS
/**
* Send message.
+ * @param data The data to send
+ * @param waitForAck Wait for an ack
+ * @throws IOException An IO error occured sending the message
*/
public void sendMessage(byte[] data, boolean waitForAck) throws
IOException {
IOException exception = null;
@@ -129,9 +132,6 @@ public class BioSender extends AbstractS
}
- /**
- * Name of this SockerSender
- */
@Override
public String toString() {
StringBuilder buf = new StringBuilder("DataSender[(");
@@ -143,8 +143,9 @@ public class BioSender extends AbstractS
// --------------------------------------------------------- Protected
Methods
/**
- * open real socket and set time out when waitForAck is enabled
- * is socket open return directly
+ * Open real socket and set time out when waitForAck is enabled
+ * is socket open return directly.
+ * @throws IOException Error opening socket
*/
protected void openSocket() throws IOException {
if(isConnected()) return ;
@@ -215,8 +216,10 @@ public class BioSender extends AbstractS
* @see #openSocket()
* @see #sendMessage(byte[], boolean)
*
- * @param data
- * data to send
+ * @param data Data to send
+ * @param reconnect Do a reconnect (close socket then reopen)
+ * @param waitForAck Wait for an acknowledgement
+ * @throws IOException IO error writing data
* @since 5.5.10
*/
@@ -234,8 +237,7 @@ public class BioSender extends AbstractS
/**
* Wait for Acknowledgement from other server.
* FIXME Please, not wait only for three characters, better control that
the wait ack message is correct.
- * @throws java.io.IOException
- * @throws java.net.SocketTimeoutException
+ * @throws IOException An IO error occurred
*/
protected void waitForAck() throws java.io.IOException {
try {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java
Thu Jan 14 14:55:44 2016
@@ -236,10 +236,9 @@ public class NioReceiver extends Receive
/**
- * get data from channel and store in byte array
+ * Get data from channel and store in byte array
* send it to cluster
- * @throws IOException
- * @throws java.nio.channels.ClosedChannelException
+ * @throws IOException IO error
*/
protected void listen() throws Exception {
if (doListen()) {
@@ -397,6 +396,11 @@ public class NioReceiver extends Receive
/**
* Register the given channel with the given selector for
* the given operations of interest
+ * @param selector The selector to use
+ * @param channel The channel
+ * @param ops The operations to register
+ * @param attach Attachment object
+ * @throws Exception IO error with channel
*/
protected void registerChannel(Selector selector,
SelectableChannel channel,
@@ -433,6 +437,7 @@ public class NioReceiver extends Receive
* channel returns an EOF condition, it is closed here, which
* automatically invalidates the associated key. The selector
* will then de-register the channel on the next select call.
+ * @throws Exception IO error with channel
*/
protected void readDataFromSocket(SelectionKey key) throws Exception {
NioReplicationTask task = (NioReplicationTask)
getTaskPool().getRxTask();
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReplicationTask.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReplicationTask.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReplicationTask.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioReplicationTask.java
Thu Jan 14 14:55:44 2016
@@ -130,6 +130,7 @@ public class NioReplicationTask extends
* updated to remove OP_READ. This will cause the selector
* to ignore read-readiness for this channel while the
* worker thread is servicing it.
+ * @param key The key to process
*/
public synchronized void serviceChannel (SelectionKey key) {
if ( log.isTraceEnabled() ) log.trace("About to service key:"+key);
@@ -147,6 +148,9 @@ public class NioReplicationTask extends
* interest in OP_READ. When this method completes it
* re-enables OP_READ and calls wakeup() on the selector
* so the selector will resume watching this channel.
+ * @param key The key to process
+ * @param reader The reader
+ * @throws Exception IO error
*/
protected void drainChannel (final SelectionKey key, ObjectReader reader)
throws Exception {
reader.access();
@@ -292,10 +296,12 @@ public class NioReplicationTask extends
/**
- * send a reply-acknowledgement (6,2,3), sends it doing a busy write, the
ACK is so small
- * that it should always go to the buffer
- * @param key
- * @param channel
+ * Send a reply-acknowledgement (6,2,3), sends it doing a busy write, the
ACK is so small
+ * that it should always go to the buffer.
+ * @param key The key to use
+ * @param channel The channel
+ * @param command The command to write
+ * @param udpaddr Target address
*/
protected void sendAck(SelectionKey key, WritableByteChannel channel,
byte[] command, SocketAddress udpaddr) {
try {
Modified:
tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/transport/nio/NioSender.java
Thu Jan 14 14:55:44 2016
@@ -75,10 +75,11 @@ public class NioSender extends AbstractS
}
/**
- * State machine to send data
- * @param key SelectionKey
- * @return boolean
- * @throws IOException
+ * State machine to send data.
+ * @param key The key to use
+ * @param waitForAck Wait for an ack
+ * @return <code>true</code> if the processing was successful
+ * @throws IOException An IO error occurred
*/
public boolean process(SelectionKey key, boolean waitForAck) throws
IOException {
int ops = key.readyOps();
Modified: tomcat/trunk/java/org/apache/catalina/users/MemoryUser.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/users/MemoryUser.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/users/MemoryUser.java (original)
+++ tomcat/trunk/java/org/apache/catalina/users/MemoryUser.java Thu Jan 14
14:55:44 2016
@@ -254,6 +254,7 @@ public class MemoryUser extends Abstract
* the reader that processes this entry will accept either
* <code>username</code> or <code>name</code> for the username
* property.</p>
+ * @return the XML representation
*/
public String toXml() {
Modified: tomcat/trunk/java/org/apache/catalina/users/MemoryUserDatabase.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/users/MemoryUserDatabase.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/users/MemoryUserDatabase.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/users/MemoryUserDatabase.java Thu Jan
14 14:55:44 2016
@@ -139,7 +139,7 @@ public class MemoryUserDatabase implemen
/**
- * Return the set of {@link Group}s defined in this user database.
+ * @return the set of {@link Group}s defined in this user database.
*/
@Override
public Iterator<Group> getGroups() {
@@ -152,7 +152,7 @@ public class MemoryUserDatabase implemen
/**
- * Return the unique global identifier of this user database.
+ * @return the unique global identifier of this user database.
*/
@Override
public String getId() {
@@ -163,7 +163,7 @@ public class MemoryUserDatabase implemen
/**
- * Return the relative or absolute pathname to the persistent storage file.
+ * @return the relative or absolute pathname to the persistent storage
file.
*/
public String getPathname() {
@@ -187,7 +187,7 @@ public class MemoryUserDatabase implemen
/**
- * Returning the readonly status of the user database
+ * @return the readonly status of the user database
*/
public boolean getReadonly() {
@@ -209,7 +209,7 @@ public class MemoryUserDatabase implemen
/**
- * Return the set of {@link Role}s defined in this user database.
+ * @return the set of {@link Role}s defined in this user database.
*/
@Override
public Iterator<Role> getRoles() {
@@ -222,7 +222,7 @@ public class MemoryUserDatabase implemen
/**
- * Return the set of {@link User}s defined in this user database.
+ * @return the set of {@link User}s defined in this user database.
*/
@Override
public Iterator<User> getUsers() {
@@ -485,6 +485,7 @@ public class MemoryUserDatabase implemen
/**
* Check for permissions to save this user database to persistent storage
* location.
+ * @return <code>true</code> if the database is writable
*/
public boolean isWriteable() {
Modified: tomcat/trunk/java/org/apache/catalina/util/CharsetMapper.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/CharsetMapper.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/CharsetMapper.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/CharsetMapper.java Thu Jan 14
14:55:44 2016
@@ -97,6 +97,7 @@ public class CharsetMapper {
* content type header.
*
* @param locale The locale for which to calculate a character set
+ * @return the charset name
*/
public String getCharset(Locale locale) {
// Match full language_country_variant first, then language_country,
Modified: tomcat/trunk/java/org/apache/catalina/util/DOMWriter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/DOMWriter.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/DOMWriter.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/DOMWriter.java Thu Jan 14
14:55:44 2016
@@ -52,7 +52,10 @@ public class DOMWriter {
}
- /** Prints the specified node, recursively. */
+ /**
+ * Prints the specified node, recursively.
+ * @param node The node to output
+ */
public void print(Node node) {
// is there anything to do?
@@ -161,7 +164,11 @@ public class DOMWriter {
}
- /** Returns a sorted list of attributes. */
+ /**
+ * Returns a sorted list of attributes.
+ * @param attrs The map to sort
+ * @return a sorted attribute array
+ */
protected Attr[] sortAttributes(NamedNodeMap attrs) {
if (attrs == null) {
return new Attr[0];
@@ -195,7 +202,11 @@ public class DOMWriter {
}
- /** Normalizes the given string. */
+ /**
+ * Normalizes the given string.
+ * @param s The string to escape
+ * @return the escaped string
+ */
protected String normalize(String s) {
if (s == null) {
return "";
Modified: tomcat/trunk/java/org/apache/catalina/util/Extension.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/Extension.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/Extension.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/Extension.java Thu Jan 14
14:55:44 2016
@@ -176,6 +176,7 @@ public final class Extension {
* <code>false</code>.
*
* @param required Extension of the required optional package
+ * @return <code>true</code> if the extension is satisfied
*/
public boolean isCompatibleWith(Extension required) {
@@ -213,9 +214,6 @@ public final class Extension {
}
- /**
- * Return a String representation of this object.
- */
@Override
public String toString() {
Modified: tomcat/trunk/java/org/apache/catalina/util/ExtensionValidator.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ExtensionValidator.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ExtensionValidator.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/util/ExtensionValidator.java Thu Jan
14 14:55:44 2016
@@ -121,6 +121,7 @@ public final class ExtensionValidator {
* application
*
* @return true if all required extensions satisfied
+ * @throws IOException Error reading resources needed for validation
*/
public static synchronized boolean validateApplication(
WebResourceRoot resources,
@@ -168,6 +169,7 @@ public final class ExtensionValidator {
* it to the container's manifest resources.
*
* @param jarFile The system JAR whose manifest to add
+ * @throws IOException Error reading JAR file
*/
public static void addSystemResource(File jarFile) throws IOException {
try (InputStream is = new FileInputStream(jarFile)) {
Modified: tomcat/trunk/java/org/apache/catalina/util/IOTools.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/IOTools.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/IOTools.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/IOTools.java Thu Jan 14 14:55:44
2016
@@ -42,6 +42,7 @@ public class IOTools {
* @param reader the reader to read from.
* @param writer the writer to write to.
* @param buf the char array to use as a buffer
+ * @throws IOException IO error
*/
public static void flow( Reader reader, Writer writer, char[] buf )
throws IOException {
@@ -52,6 +53,12 @@ public class IOTools {
}
/**
+ * Read input from reader and write it to writer until there is no more
+ * input from reader.
+ *
+ * @param reader the reader to read from.
+ * @param writer the writer to write to.
+ * @throws IOException IO error
* @see #flow( Reader, Writer, char[] )
*/
public static void flow( Reader reader, Writer writer )
Modified: tomcat/trunk/java/org/apache/catalina/util/Introspection.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/Introspection.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/Introspection.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/Introspection.java Thu Jan 14
14:55:44 2016
@@ -44,6 +44,8 @@ public class Introspection {
*
* Note: This method assumes that the method name has already been checked
* for correctness.
+ * @param setter The setter method
+ * @return the bean property name
*/
public static String getPropertyName(Method setter) {
return Introspector.decapitalize(setter.getName().substring(3));
@@ -91,6 +93,8 @@ public class Introspection {
/**
* Obtain the declared fields for a class taking account of any security
* manager that may be configured.
+ * @param clazz The class to introspect
+ * @return the class fields as an array
*/
public static Field[] getDeclaredFields(final Class<?> clazz) {
Field[] fields = null;
@@ -112,6 +116,8 @@ public class Introspection {
/**
* Obtain the declared methods for a class taking account of any security
* manager that may be configured.
+ * @param clazz The class to introspect
+ * @return the class methods as an array
*/
public static Method[] getDeclaredMethods(final Class<?> clazz) {
Method[] methods = null;
@@ -134,6 +140,10 @@ public class Introspection {
* Attempt to load a class using the given Container's class loader. If the
* class cannot be loaded, a debug level log message will be written to the
* Container's log and null will be returned.
+ * @param context The class loader of this context will be used to attemmpt
+ * to load the class
+ * @param className The class name
+ * @return the loaded class or <code>null</code> if loading failed
*/
public static Class<?> loadClass(Context context, String className) {
ClassLoader cl = context.getLoader().getClassLoader();
Modified: tomcat/trunk/java/org/apache/catalina/util/MIME2Java.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/MIME2Java.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/MIME2Java.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/MIME2Java.java Thu Jan 14
14:55:44 2016
@@ -30,441 +30,440 @@ import java.util.Map;
* as <code>TXDocument#setEncoding</code> and <code>DTD#setEncoding</code>.
* <p>Java encoding names are used on <var>encoding</var> parameters to
* methods such as <code>TXDocument#printWithFormat</code> and
<code>DTD#printExternal</code>.
- * <P>
* <TABLE BORDER="0" WIDTH="100%">
* <caption>MIME charset name to Java encoding name mapping</caption>
* <TR>
- * <TD WIDTH="33%">
- * <P ALIGN="CENTER"><B>Common Name</B>
+ * <TD>
+ * <P><B>Common Name</B>
* </TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER"><B>Use this name in XML files</B>
+ * <TD>
+ * <P><B>Use this name in XML files</B>
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER"><B>Name Type</B>
+ * <TD>
+ * <P><B>Name Type</B>
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER"><B>Xerces converts to this Java Encoder Name</B>
+ * <TD>
+ * <P><B>Xerces converts to this Java Encoder Name</B>
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">8 bit Unicode</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">UTF-8
+ * <TD>8 bit Unicode</TD>
+ * <TD>
+ * <P>UTF-8
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">UTF8
+ * <TD>
+ * <P>UTF8
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin 1</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-1
+ * <TD>ISO Latin 1</TD>
+ * <TD>
+ * <P>ISO-8859-1
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-1
+ * <TD>
+ * <P>ISO-8859-1
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin 2</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-2
+ * <TD>ISO Latin 2</TD>
+ * <TD>
+ * <P>ISO-8859-2
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-2
+ * <TD>
+ * <P>ISO-8859-2
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin 3</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-3
+ * <TD>ISO Latin 3</TD>
+ * <TD>
+ * <P>ISO-8859-3
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-3
+ * <TD>
+ * <P>ISO-8859-3
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin 4</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-4
+ * <TD>ISO Latin 4</TD>
+ * <TD>
+ * <P>ISO-8859-4
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-4
+ * <TD>
+ * <P>ISO-8859-4
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin Cyrillic</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-5
+ * <TD>ISO Latin Cyrillic</TD>
+ * <TD>
+ * <P>ISO-8859-5
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-5
+ * <TD>
+ * <P>ISO-8859-5
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin Arabic</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-6
+ * <TD>ISO Latin Arabic</TD>
+ * <TD>
+ * <P>ISO-8859-6
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-6
+ * <TD>
+ * <P>ISO-8859-6
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin Greek</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-7
+ * <TD>ISO Latin Greek</TD>
+ * <TD>
+ * <P>ISO-8859-7
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-7
+ * <TD>
+ * <P>ISO-8859-7
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin Hebrew</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-8
+ * <TD>ISO Latin Hebrew</TD>
+ * <TD>
+ * <P>ISO-8859-8
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-8
+ * <TD>
+ * <P>ISO-8859-8
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">ISO Latin 5</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ISO-8859-9
+ * <TD>ISO Latin 5</TD>
+ * <TD>
+ * <P>ISO-8859-9
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">ISO-8859-9
+ * <TD>
+ * <P>ISO-8859-9
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: US</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-us
+ * <TD>EBCDIC: US</TD>
+ * <TD>
+ * <P>ebcdic-cp-us
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp037
+ * <TD>
+ * <P>cp037
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Canada</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-ca
+ * <TD>EBCDIC: Canada</TD>
+ * <TD>
+ * <P>ebcdic-cp-ca
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp037
+ * <TD>
+ * <P>cp037
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Netherlands</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-nl
+ * <TD>EBCDIC: Netherlands</TD>
+ * <TD>
+ * <P>ebcdic-cp-nl
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp037
+ * <TD>
+ * <P>cp037
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Denmark</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-dk
+ * <TD>EBCDIC: Denmark</TD>
+ * <TD>
+ * <P>ebcdic-cp-dk
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp277
+ * <TD>
+ * <P>cp277
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Norway</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-no
+ * <TD>EBCDIC: Norway</TD>
+ * <TD>
+ * <P>ebcdic-cp-no
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp277
+ * <TD>
+ * <P>cp277
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Finland</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-fi
+ * <TD>EBCDIC: Finland</TD>
+ * <TD>
+ * <P>ebcdic-cp-fi
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp278
+ * <TD>
+ * <P>cp278
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Sweden</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-se
+ * <TD>EBCDIC: Sweden</TD>
+ * <TD>
+ * <P>ebcdic-cp-se
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp278
+ * <TD>
+ * <P>cp278
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Italy</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-it
+ * <TD>EBCDIC: Italy</TD>
+ * <TD>
+ * <P>ebcdic-cp-it
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp280
+ * <TD>
+ * <P>cp280
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Spain, Latin America</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-es
+ * <TD>EBCDIC: Spain, Latin America</TD>
+ * <TD>
+ * <P>ebcdic-cp-es
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp284
+ * <TD>
+ * <P>cp284
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Great Britain</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-gb
+ * <TD>EBCDIC: Great Britain</TD>
+ * <TD>
+ * <P>ebcdic-cp-gb
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp285
+ * <TD>
+ * <P>cp285
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: France</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-fr
+ * <TD>EBCDIC: France</TD>
+ * <TD>
+ * <P>ebcdic-cp-fr
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp297
+ * <TD>
+ * <P>cp297
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Arabic</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-ar1
+ * <TD>EBCDIC: Arabic</TD>
+ * <TD>
+ * <P>ebcdic-cp-ar1
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp420
+ * <TD>
+ * <P>cp420
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Hebrew</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-he
+ * <TD>EBCDIC: Hebrew</TD>
+ * <TD>
+ * <P>ebcdic-cp-he
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp424
+ * <TD>
+ * <P>cp424
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Switzerland</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-ch
+ * <TD>EBCDIC: Switzerland</TD>
+ * <TD>
+ * <P>ebcdic-cp-ch
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp500
+ * <TD>
+ * <P>cp500
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Roece</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-roece
+ * <TD>EBCDIC: Roece</TD>
+ * <TD>
+ * <P>ebcdic-cp-roece
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp870
+ * <TD>
+ * <P>cp870
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Yogoslavia</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-yu
+ * <TD>EBCDIC: Yogoslavia</TD>
+ * <TD>
+ * <P>ebcdic-cp-yu
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp870
+ * <TD>
+ * <P>cp870
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Iceland</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-is
+ * <TD>EBCDIC: Iceland</TD>
+ * <TD>
+ * <P>ebcdic-cp-is
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp871
+ * <TD>
+ * <P>cp871
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">EBCDIC: Urdu</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">ebcdic-cp-ar2
+ * <TD>EBCDIC: Urdu</TD>
+ * <TD>
+ * <P>ebcdic-cp-ar2
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">IANA
+ * <TD>
+ * <P>IANA
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">cp918
+ * <TD>
+ * <P>cp918
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Chinese for PRC, mixed 1/2 byte</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">gb2312
+ * <TD>Chinese for PRC, mixed 1/2 byte</TD>
+ * <TD>
+ * <P>gb2312
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">GB2312
+ * <TD>
+ * <P>GB2312
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Extended Unix Code, packed for Japanese</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">euc-jp
+ * <TD>Extended Unix Code, packed for Japanese</TD>
+ * <TD>
+ * <P>euc-jp
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">eucjis
+ * <TD>
+ * <P>eucjis
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Japanese: iso-2022-jp</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">iso-2020-jp
+ * <TD>Japanese: iso-2022-jp</TD>
+ * <TD>
+ * <P>iso-2020-jp
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">JIS
+ * <TD>
+ * <P>JIS
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Japanese: Shift JIS</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">Shift_JIS
+ * <TD>Japanese: Shift JIS</TD>
+ * <TD>
+ * <P>Shift_JIS
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">SJIS
+ * <TD>
+ * <P>SJIS
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Chinese: Big5</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">Big5
+ * <TD>Chinese: Big5</TD>
+ * <TD>
+ * <P>Big5
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">Big5
+ * <TD>
+ * <P>Big5
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Extended Unix Code, packed for Korean</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">euc-kr
+ * <TD>Extended Unix Code, packed for Korean</TD>
+ * <TD>
+ * <P>euc-kr
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">iso2022kr
+ * <TD>
+ * <P>iso2022kr
* </TD>
* </TR>
* <TR>
- * <TD WIDTH="33%">Cyrillic</TD>
- * <TD WIDTH="15%">
- * <P ALIGN="CENTER">koi8-r
+ * <TD>Cyrillic</TD>
+ * <TD>
+ * <P>koi8-r
* </TD>
- * <TD WIDTH="12%">
- * <P ALIGN="CENTER">MIME
+ * <TD>
+ * <P>MIME
* </TD>
- * <TD WIDTH="31%">
- * <P ALIGN="CENTER">koi8-r
+ * <TD>
+ * <P>koi8-r
* </TD>
* </TR>
* </TABLE>
Modified: tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/ParameterMap.java Thu Jan 14
14:55:44 2016
@@ -96,7 +96,7 @@ public final class ParameterMap<K,V> ext
/**
- * Return the locked state of this parameter map.
+ * @return the locked state of this parameter map.
*/
public boolean isLocked() {
Modified: tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/ResourceSet.java Thu Jan 14
14:55:44 2016
@@ -99,7 +99,7 @@ public final class ResourceSet<T> extend
/**
- * Return the locked state of this parameter map.
+ * @return the locked state of this parameter map.
*/
public boolean isLocked() {
Modified: tomcat/trunk/java/org/apache/catalina/util/ServerInfo.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/ServerInfo.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/ServerInfo.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/ServerInfo.java Thu Jan 14
14:55:44 2016
@@ -85,7 +85,7 @@ public class ServerInfo {
/**
- * Return the server identification for this version of Tomcat.
+ * @return the server identification for this version of Tomcat.
*/
public static String getServerInfo() {
@@ -94,7 +94,7 @@ public class ServerInfo {
}
/**
- * Return the server built time for this version of Tomcat.
+ * @return the server built time for this version of Tomcat.
*/
public static String getServerBuilt() {
@@ -103,7 +103,7 @@ public class ServerInfo {
}
/**
- * Return the server's version number.
+ * @return the server's version number.
*/
public static String getServerNumber() {
Modified: tomcat/trunk/java/org/apache/catalina/util/SessionConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/SessionConfig.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/SessionConfig.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/SessionConfig.java Thu Jan 14
14:55:44 2016
@@ -28,7 +28,8 @@ public class SessionConfig {
/**
* Determine the name to use for the session cookie for the provided
* context.
- * @param context
+ * @param context The context
+ * @return the cookie name for the context
*/
public static String getSessionCookieName(Context context) {
@@ -44,7 +45,8 @@ public class SessionConfig {
/**
* Determine the name to use for the session cookie for the provided
* context.
- * @param context
+ * @param context The context
+ * @return the parameter name for the session
*/
public static String getSessionUriParamName(Context context) {
Modified: tomcat/trunk/java/org/apache/catalina/util/Strftime.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/Strftime.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/Strftime.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/Strftime.java Thu Jan 14
14:55:44 2016
@@ -139,6 +139,7 @@ public class Strftime {
/**
* Change the timezone used to format dates
*
+ * @param timeZone The new time zone
* @see SimpleDateFormat#setTimeZone
*/
public void setTimeZone( TimeZone timeZone ) {
Modified: tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java?rev=1724626&r1=1724625&r2=1724626&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java (original)
+++ tomcat/trunk/java/org/apache/catalina/util/XMLWriter.java Thu Jan 14
14:55:44 2016
@@ -22,8 +22,6 @@ import java.io.Writer;
/**
* XMLWriter helper class.
- *
- * @author <a href="mailto:r...@apache.org";>Remy Maucherat</a>
*/
public class XMLWriter {
@@ -68,7 +66,7 @@ public class XMLWriter {
/**
- * Constructor.
+ * New XML writer utility that will store its data in an internal buffer.
*/
public XMLWriter() {
this(null);
@@ -76,7 +74,10 @@ public class XMLWriter {
/**
- * Constructor.
+ * New XML writer utility that will store its data in an internal buffer
+ * and can write it to the specified writer.
+ * @see sendData
+ * @param writer The writer to use
*/
public XMLWriter(Writer writer) {
this.writer = writer;
@@ -204,7 +205,8 @@ public class XMLWriter {
/**
- * Send data and reinitializes buffer.
+ * Send data and reinitializes buffer, if a writer has been specified.
+ * @throws IOException Error writing XML data
*/
public void sendData()
throws IOException {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
