Updated APIviz tags

This commit is contained in:
Trustin Lee 2009-07-20 04:50:03 +00:00
parent f15db3a65e
commit 0277a68c49
29 changed files with 75 additions and 4 deletions

View File

@ -25,6 +25,6 @@
* Simplistic abstract classes which help implement encoder and decoder that * Simplistic abstract classes which help implement encoder and decoder that
* transform an object into another object and vice versa. * transform an object into another object and vice versa.
* *
* @apiviz.exclude * @apiviz.exclude \.codec\.(?!oneone)[a-z0-9]+\.
*/ */
package org.jboss.netty.handler.codec.oneone; package org.jboss.netty.handler.codec.oneone;

View File

@ -26,5 +26,7 @@
* <a href="http://code.google.com/p/protobuf/">Google Protocol Buffers</a> * <a href="http://code.google.com/p/protobuf/">Google Protocol Buffers</a>
* {@link com.google.protobuf.Message} into a {@link org.jboss.netty.buffer.ChannelBuffer} * {@link com.google.protobuf.Message} into a {@link org.jboss.netty.buffer.ChannelBuffer}
* and vice versa. * and vice versa.
*
* @apiviz.exclude \.oneone\.
*/ */
package org.jboss.netty.handler.codec.protobuf; package org.jboss.netty.handler.codec.protobuf;

View File

@ -250,6 +250,7 @@ import org.jboss.netty.handler.codec.frame.FrameDecoder;
* the state type; use {@link VoidEnum} if state management is unused * the state type; use {@link VoidEnum} if state management is unused
* *
* @apiviz.landmark * @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.codec.replay.UnreplayableOperationException oneway - - throws
*/ */
@ChannelPipelineCoverage("one") @ChannelPipelineCoverage("one")
public abstract class ReplayingDecoder<T extends Enum<T>> public abstract class ReplayingDecoder<T extends Enum<T>>

View File

@ -25,6 +25,11 @@
* Specialized variation of {@link org.jboss.netty.handler.codec.frame.FrameDecoder} * Specialized variation of {@link org.jboss.netty.handler.codec.frame.FrameDecoder}
* which enables implementation of a non-blocking decoder in the blocking I/O * which enables implementation of a non-blocking decoder in the blocking I/O
* paradigm. * paradigm.
*
* @apiviz.exclude ^java\.lang\.
* @apiviz.exclude \.SimpleChannelUpstreamHandler$
* @apiviz.exclude \.VoidEnum$
* @apiviz.exclude \.codec\.(?!replay)[a-z0-9]+\.
*/ */
package org.jboss.netty.handler.codec.replay; package org.jboss.netty.handler.codec.replay;

View File

@ -46,6 +46,7 @@ import org.jboss.netty.handler.codec.frame.FrameDecoder;
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @apiviz.landmark * @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.codec.serialization.ObjectDecoderInputStream - - - compatible with
*/ */
public class ObjectDecoder extends FrameDecoder { public class ObjectDecoder extends FrameDecoder {

View File

@ -48,6 +48,7 @@ import org.jboss.netty.handler.codec.oneone.OneToOneEncoder;
* @version $Rev:231 $, $Date:2008-06-12 16:44:50 +0900 (, 12 6월 2008) $ * @version $Rev:231 $, $Date:2008-06-12 16:44:50 +0900 (, 12 6월 2008) $
* *
* @apiviz.landmark * @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.codec.serialization.ObjectEncoderOutputStream - - - compatible with
*/ */
@ChannelPipelineCoverage("all") @ChannelPipelineCoverage("all")
public class ObjectEncoder extends OneToOneEncoder { public class ObjectEncoder extends OneToOneEncoder {

View File

@ -26,6 +26,8 @@
* transform a {@link java.io.Serializable} object into a byte buffer and * transform a {@link java.io.Serializable} object into a byte buffer and
* vice versa. * vice versa.
* *
* @apiviz.exclude ^java\..*Stream$ * @apiviz.exclude ^java\.io\.
* @apiviz.exclude \.codec\.(?!serialization)[a-z0-9]+\.
* @apiviz.exclude \.CompatibleObjectDecoder$
*/ */
package org.jboss.netty.handler.codec.serialization; package org.jboss.netty.handler.codec.serialization;

View File

@ -24,5 +24,7 @@
/** /**
* Encoder and decoder which transform a {@link java.lang.String} into a * Encoder and decoder which transform a {@link java.lang.String} into a
* {@link org.jboss.netty.buffer.ChannelBuffer} and vice versa. * {@link org.jboss.netty.buffer.ChannelBuffer} and vice versa.
*
* @apiviz.exclude \.oneone\.
*/ */
package org.jboss.netty.handler.codec.string; package org.jboss.netty.handler.codec.string;

View File

@ -85,8 +85,8 @@ import org.jboss.netty.util.internal.LinkedTransferQueue;
* *
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @apiviz.uses org.jboss.netty.util.ObjectSizeEstimator * @apiviz.has org.jboss.netty.util.ObjectSizeEstimator oneway - -
* @apiviz.uses org.jboss.netty.handler.execution.ChannelEventRunnable * @apiviz.has org.jboss.netty.handler.execution.ChannelEventRunnable - - executes
*/ */
public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor { public class MemoryAwareThreadPoolExecutor extends ThreadPoolExecutor {

View File

@ -26,5 +26,9 @@
* thread models and memory overload prevention mechanisms. * thread models and memory overload prevention mechanisms.
* *
* @apiviz.exclude ^java\.lang\. * @apiviz.exclude ^java\.lang\.
* @apiviz.exclude \.netty\.channel\.
* @apiviz.exclude \.ExternalResourceReleasable$
* @apiviz.exclude \.ChannelEventRunnable$
*
*/ */
package org.jboss.netty.handler.execution; package org.jboss.netty.handler.execution;

View File

@ -46,6 +46,8 @@ import org.jboss.netty.logging.InternalLoggerFactory;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
*/ */
@ChannelPipelineCoverage("all") @ChannelPipelineCoverage("all")
public class LoggingHandler implements ChannelUpstreamHandler, ChannelDownstreamHandler { public class LoggingHandler implements ChannelUpstreamHandler, ChannelDownstreamHandler {

View File

@ -26,5 +26,6 @@
* using an {@link org.jboss.netty.logging.InternalLogger}. * using an {@link org.jboss.netty.logging.InternalLogger}.
* *
* @apiviz.hidden * @apiviz.hidden
* @apiviz.exclude \.channel\.
*/ */
package org.jboss.netty.handler.logging; package org.jboss.netty.handler.logging;

View File

@ -24,5 +24,7 @@
/** /**
* <a href="http://en.wikipedia.org/wiki/Transport_Layer_Security">SSL &middot; * <a href="http://en.wikipedia.org/wiki/Transport_Layer_Security">SSL &middot;
* TLS</a> implementation based on {@link javax.net.ssl.SSLEngine} * TLS</a> implementation based on {@link javax.net.ssl.SSLEngine}
*
* @apiviz.exclude \.(channel|codec)\.
*/ */
package org.jboss.netty.handler.ssl; package org.jboss.netty.handler.ssl;

View File

@ -30,6 +30,8 @@ import org.jboss.netty.buffer.ChannelBuffer;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
*/ */
public interface ChunkedInput { public interface ChunkedInput {

View File

@ -69,6 +69,9 @@ import org.jboss.netty.util.internal.LinkedTransferQueue;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.stream.ChunkedInput oneway - - reads from
*/ */
@ChannelPipelineCoverage("one") @ChannelPipelineCoverage("one")
public class ChunkedWriteHandler implements ChannelUpstreamHandler, ChannelDownstreamHandler { public class ChunkedWriteHandler implements ChannelUpstreamHandler, ChannelDownstreamHandler {

View File

@ -25,5 +25,7 @@
* Writes very large data stream asynchronously neither spending a lot of * Writes very large data stream asynchronously neither spending a lot of
* memory nor getting {@link java.lang.OutOfMemoryError}. For a detailed * memory nor getting {@link java.lang.OutOfMemoryError}. For a detailed
* example, please refer to {@code org.jboss.netty.example.http.file}. * example, please refer to {@code org.jboss.netty.example.http.file}.
*
* @apiviz.exclude \.channel\.
*/ */
package org.jboss.netty.handler.stream; package org.jboss.netty.handler.stream;

View File

@ -34,6 +34,8 @@ import org.jboss.netty.channel.SimpleChannelHandler;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.uses org.jboss.netty.handler.timeout.IdleStateEvent
*/ */
public class IdleStateAwareChannelHandler extends SimpleChannelHandler { public class IdleStateAwareChannelHandler extends SimpleChannelHandler {

View File

@ -34,6 +34,8 @@ import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.uses org.jboss.netty.handler.timeout.IdleStateEvent
*/ */
public class IdleStateAwareChannelUpstreamHandler extends SimpleChannelUpstreamHandler { public class IdleStateAwareChannelUpstreamHandler extends SimpleChannelUpstreamHandler {

View File

@ -32,6 +32,9 @@ import org.jboss.netty.channel.ChannelEvent;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
* @apiviz.has org.jboss.netty.handler.timeout.IdleState oneway - -
*/ */
public interface IdleStateEvent extends ChannelEvent { public interface IdleStateEvent extends ChannelEvent {
/** /**

View File

@ -76,6 +76,10 @@ import org.jboss.netty.util.TimerTask;
* @see HashedWheelTimer * @see HashedWheelTimer
* @see ReadTimeoutHandler * @see ReadTimeoutHandler
* @see WriteTimeoutHandler * @see WriteTimeoutHandler
*
* @apiviz.landmark
* @apiviz.uses org.jboss.netty.util.HashedWheelTimer
* @apiviz.has org.jboss.netty.handler.timeout.IdleStateEvent oneway - - triggers
*/ */
@ChannelPipelineCoverage("one") @ChannelPipelineCoverage("one")
public class IdleStateHandler extends SimpleChannelUpstreamHandler public class IdleStateHandler extends SimpleChannelUpstreamHandler

View File

@ -50,6 +50,10 @@ import org.jboss.netty.util.TimerTask;
* @see HashedWheelTimer * @see HashedWheelTimer
* @see WriteTimeoutHandler * @see WriteTimeoutHandler
* @see IdleStateHandler * @see IdleStateHandler
*
* @apiviz.landmark
* @apiviz.uses org.jboss.netty.util.HashedWheelTimer
* @apiviz.has org.jboss.netty.handler.timeout.TimeoutException oneway - - raises
*/ */
@ChannelPipelineCoverage("one") @ChannelPipelineCoverage("one")
public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler public class ReadTimeoutHandler extends SimpleChannelUpstreamHandler

View File

@ -50,6 +50,10 @@ import org.jboss.netty.util.TimerTask;
* @see HashedWheelTimer * @see HashedWheelTimer
* @see ReadTimeoutHandler * @see ReadTimeoutHandler
* @see IdleStateHandler * @see IdleStateHandler
*
* @apiviz.landmark
* @apiviz.uses org.jboss.netty.util.HashedWheelTimer
* @apiviz.has org.jboss.netty.handler.timeout.TimeoutException oneway - - raises
*/ */
@ChannelPipelineCoverage("all") @ChannelPipelineCoverage("all")
public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler public class WriteTimeoutHandler extends SimpleChannelDownstreamHandler

View File

@ -24,5 +24,9 @@
/** /**
* Adds support for read and write timeout and idle connection notification * Adds support for read and write timeout and idle connection notification
* using a {@link org.jboss.netty.util.Timer}. * using a {@link org.jboss.netty.util.Timer}.
*
* @apiviz.exclude \.channel\.
* @apiviz.exclude \.DefaultIdleStateEvent$
* @apiviz.exclude \.ExternalResourceReleasable$
*/ */
package org.jboss.netty.handler.timeout; package org.jboss.netty.handler.timeout;

View File

@ -29,6 +29,8 @@ package org.jboss.netty.util;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
*/ */
public interface ExternalResourceReleasable { public interface ExternalResourceReleasable {

View File

@ -30,6 +30,9 @@ package org.jboss.netty.util;
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* *
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
* @apiviz.uses org.jboss.netty.util.EstimatableObjectWrapper
*/ */
public interface ObjectSizeEstimator { public interface ObjectSizeEstimator {

View File

@ -35,6 +35,9 @@ import org.jboss.netty.logging.InternalLoggerFactory;
* *
* @version $Rev$, $Date$ * @version $Rev$, $Date$
* *
* @apiviz.landmark
* @apiviz.has org.jboss.netty.util.ThreadNameDeterminer oneway - -
*
*/ */
public class ThreadRenamingRunnable implements Runnable { public class ThreadRenamingRunnable implements Runnable {

View File

@ -32,6 +32,10 @@ import java.util.concurrent.TimeUnit;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
* @apiviz.has org.jboss.netty.util.TimerTask oneway - - executes
* @apiviz.has org.jboss.netty.util.Timeout oneway - - creates
*/ */
public interface Timer { public interface Timer {

View File

@ -80,6 +80,8 @@ import org.jboss.netty.util.internal.MapBackedSet;
* @author The Netty Project (netty-dev@lists.jboss.org) * @author The Netty Project (netty-dev@lists.jboss.org)
* @author Trustin Lee (tlee@redhat.com) * @author Trustin Lee (tlee@redhat.com)
* @version $Rev$, $Date$ * @version $Rev$, $Date$
*
* @apiviz.landmark
*/ */
public class VirtualExecutorService extends AbstractExecutorService { public class VirtualExecutorService extends AbstractExecutorService {

View File

@ -25,5 +25,9 @@
* Utility classes used across multiple packages. * Utility classes used across multiple packages.
* *
* @apiviz.exclude * @apiviz.exclude
* @apiviz.exclude ^java\.(lang|util)\.
* @apiviz.exclude \.netty\.(?!util)[a-z0-9]+\.
* @apiviz.exclude Util$
* @apiviz.exclude \.EstimatableObjectWrapper$
*/ */
package org.jboss.netty.util; package org.jboss.netty.util;