From 48696d909f82558eb9f43f06ee7b1e8c5741f21c Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Fri, 16 Apr 2010 04:12:43 +0000 Subject: [PATCH] Updated APIviz tags --- .../channel/local/DefaultLocalClientChannelFactory.java | 2 ++ .../channel/local/DefaultLocalServerChannelFactory.java | 2 ++ .../java/org/jboss/netty/channel/local/LocalAddress.java | 2 ++ src/main/java/org/jboss/netty/channel/package-info.java | 5 +++-- .../java/org/jboss/netty/handler/codec/base64/Base64.java | 1 + .../org/jboss/netty/handler/codec/base64/Base64Decoder.java | 1 + .../org/jboss/netty/handler/codec/base64/Base64Encoder.java | 1 + .../jboss/netty/handler/codec/compression/ZlibDecoder.java | 3 +++ .../jboss/netty/handler/codec/compression/ZlibEncoder.java | 3 +++ .../jboss/netty/handler/codec/compression/package-info.java | 1 + .../org/jboss/netty/handler/codec/frame/package-info.java | 2 +- .../java/org/jboss/netty/handler/codec/http/Cookie.java | 2 -- .../org/jboss/netty/handler/codec/http/HttpClientCodec.java | 3 +++ .../org/jboss/netty/handler/codec/http/HttpServerCodec.java | 3 +++ .../org/jboss/netty/handler/codec/http/package-info.java | 6 ++++-- 15 files changed, 30 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java b/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java index 4175caa221..7648670d4b 100644 --- a/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java +++ b/src/main/java/org/jboss/netty/channel/local/DefaultLocalClientChannelFactory.java @@ -25,6 +25,8 @@ import org.jboss.netty.channel.ChannelSink; * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee * @version $Rev$, $Date$ + * + * @apiviz.landmark */ public class DefaultLocalClientChannelFactory implements LocalClientChannelFactory { diff --git a/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java b/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java index 4f2e3e4dfe..513b8db5ab 100644 --- a/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java +++ b/src/main/java/org/jboss/netty/channel/local/DefaultLocalServerChannelFactory.java @@ -25,6 +25,8 @@ import org.jboss.netty.channel.ChannelSink; * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee * @version $Rev$, $Date$ + * + * @apiviz.landmark */ public class DefaultLocalServerChannelFactory implements LocalServerChannelFactory { diff --git a/src/main/java/org/jboss/netty/channel/local/LocalAddress.java b/src/main/java/org/jboss/netty/channel/local/LocalAddress.java index c89c1def82..4b5a8373a3 100644 --- a/src/main/java/org/jboss/netty/channel/local/LocalAddress.java +++ b/src/main/java/org/jboss/netty/channel/local/LocalAddress.java @@ -32,6 +32,8 @@ import java.net.SocketAddress; * @author Andy Taylor (andy.taylor@jboss.org) * @author Trustin Lee * @version $Rev$, $Date$ + * + * @apiviz.landmark */ public final class LocalAddress extends SocketAddress implements Comparable { diff --git a/src/main/java/org/jboss/netty/channel/package-info.java b/src/main/java/org/jboss/netty/channel/package-info.java index 762d14a0ca..e1200429d8 100644 --- a/src/main/java/org/jboss/netty/channel/package-info.java +++ b/src/main/java/org/jboss/netty/channel/package-info.java @@ -23,13 +23,14 @@ * @apiviz.exclude ^java * @apiviz.exclude ^org\.jboss\.netty\.channel\.[^\.]+\. * @apiviz.exclude ^org\.jboss\.netty\.(bootstrap|handler|util)\. - * @apiviz.exclude \.(Abstract|Default).*$ + * @apiviz.exclude \.(Abstract|Default|Static).*$ * @apiviz.exclude \.(Downstream|Upstream).*Event$ * @apiviz.exclude \.[A-Za-z]+ChannelFuture$ * @apiviz.exclude \.ChannelPipelineFactory$ * @apiviz.exclude \.ChannelHandlerContext$ * @apiviz.exclude \.ChannelSink$ * @apiviz.exclude \.ChannelLocal$ - * @apiviz.exclude \.[^\.]+ReceiveBufferSizePredictor$ + * @apiviz.exclude \.[^\.]+ReceiveBufferSizePredictor(Factory)?$ + * @apiviz.exclude \.FileRegion$ */ package org.jboss.netty.channel; diff --git a/src/main/java/org/jboss/netty/handler/codec/base64/Base64.java b/src/main/java/org/jboss/netty/handler/codec/base64/Base64.java index aef0a689dd..89063cc518 100644 --- a/src/main/java/org/jboss/netty/handler/codec/base64/Base64.java +++ b/src/main/java/org/jboss/netty/handler/codec/base64/Base64.java @@ -35,6 +35,7 @@ import org.jboss.netty.buffer.HeapChannelBufferFactory; * @author Trustin Lee * @version $Rev$, $Date$ * + * @apiviz.landmark * @apiviz.uses org.jboss.netty.handler.codec.base64.Base64Dialect */ public class Base64 { diff --git a/src/main/java/org/jboss/netty/handler/codec/base64/Base64Decoder.java b/src/main/java/org/jboss/netty/handler/codec/base64/Base64Decoder.java index 6cc5228003..e719ac11d0 100644 --- a/src/main/java/org/jboss/netty/handler/codec/base64/Base64Decoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/base64/Base64Decoder.java @@ -48,6 +48,7 @@ import org.jboss.netty.util.CharsetUtil; * @author Trustin Lee * @version $Rev$, $Date$ * + * @apiviz.landmark * @apiviz.uses org.jboss.netty.handler.codec.base64.Base64 */ @Sharable diff --git a/src/main/java/org/jboss/netty/handler/codec/base64/Base64Encoder.java b/src/main/java/org/jboss/netty/handler/codec/base64/Base64Encoder.java index 954822606d..e619b82717 100644 --- a/src/main/java/org/jboss/netty/handler/codec/base64/Base64Encoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/base64/Base64Encoder.java @@ -42,6 +42,7 @@ import org.jboss.netty.handler.codec.oneone.OneToOneEncoder; * @author Trustin Lee * @version $Rev$, $Date$ * + * @apiviz.landmark * @apiviz.uses org.jboss.netty.handler.codec.base64.Base64 */ @Sharable diff --git a/src/main/java/org/jboss/netty/handler/codec/compression/ZlibDecoder.java b/src/main/java/org/jboss/netty/handler/codec/compression/ZlibDecoder.java index f326522478..44585ed1d1 100644 --- a/src/main/java/org/jboss/netty/handler/codec/compression/ZlibDecoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/compression/ZlibDecoder.java @@ -30,6 +30,9 @@ import org.jboss.netty.util.internal.jzlib.ZStream; * @author The Netty Project * @author Trustin Lee * @version $Rev$, $Date$ + * + * @apiviz.landmark + * @apiviz.has org.jboss.netty.handler.codec.compression.ZlibWrapper */ public class ZlibDecoder extends OneToOneDecoder { diff --git a/src/main/java/org/jboss/netty/handler/codec/compression/ZlibEncoder.java b/src/main/java/org/jboss/netty/handler/codec/compression/ZlibEncoder.java index 08239fe17e..e8da93467a 100644 --- a/src/main/java/org/jboss/netty/handler/codec/compression/ZlibEncoder.java +++ b/src/main/java/org/jboss/netty/handler/codec/compression/ZlibEncoder.java @@ -38,6 +38,9 @@ import org.jboss.netty.util.internal.jzlib.ZStream; * @author The Netty Project * @author Trustin Lee * @version $Rev$, $Date$ + * + * @apiviz.landmark + * @apiviz.has org.jboss.netty.handler.codec.compression.ZlibWrapper */ public class ZlibEncoder extends OneToOneEncoder implements LifeCycleAwareChannelHandler { diff --git a/src/main/java/org/jboss/netty/handler/codec/compression/package-info.java b/src/main/java/org/jboss/netty/handler/codec/compression/package-info.java index afbee6b6fc..9849fca863 100644 --- a/src/main/java/org/jboss/netty/handler/codec/compression/package-info.java +++ b/src/main/java/org/jboss/netty/handler/codec/compression/package-info.java @@ -22,6 +22,7 @@ * @apiviz.exclude \.codec\.(?!compression)[a-z0-9]+\. * @apiviz.exclude ^java\.lang\. * @apiviz.exclude \.channel\. + * @apiviz.exclude Exception$ */ package org.jboss.netty.handler.codec.compression; // TODO Implement bzip2 and lzma handlers diff --git a/src/main/java/org/jboss/netty/handler/codec/frame/package-info.java b/src/main/java/org/jboss/netty/handler/codec/frame/package-info.java index 6d00611f54..c47c8afe8c 100644 --- a/src/main/java/org/jboss/netty/handler/codec/frame/package-info.java +++ b/src/main/java/org/jboss/netty/handler/codec/frame/package-info.java @@ -21,7 +21,7 @@ * * @apiviz.exclude OneToOne(Encoder|Decoder)$ * @apiviz.exclude \.(Simple)?Channel[A-Za-z]*Handler$ - * @apiviz.exclude \.codec\.serialization\. + * @apiviz.exclude \.codec\.[a-eg-z][a-z0-9]*\. * @apiviz.exclude \.ssl\. */ package org.jboss.netty.handler.codec.frame; diff --git a/src/main/java/org/jboss/netty/handler/codec/http/Cookie.java b/src/main/java/org/jboss/netty/handler/codec/http/Cookie.java index d0fdf8f416..1c5ebd49c6 100644 --- a/src/main/java/org/jboss/netty/handler/codec/http/Cookie.java +++ b/src/main/java/org/jboss/netty/handler/codec/http/Cookie.java @@ -24,8 +24,6 @@ import java.util.Set; * @author Trustin Lee * @author Andy Taylor (andy.taylor@jboss.org) * @version $Rev$, $Date$ - * - * @apiviz.landmark */ public interface Cookie extends Comparable { diff --git a/src/main/java/org/jboss/netty/handler/codec/http/HttpClientCodec.java b/src/main/java/org/jboss/netty/handler/codec/http/HttpClientCodec.java index 0dc9788123..65a553350c 100644 --- a/src/main/java/org/jboss/netty/handler/codec/http/HttpClientCodec.java +++ b/src/main/java/org/jboss/netty/handler/codec/http/HttpClientCodec.java @@ -39,6 +39,9 @@ import org.jboss.netty.util.internal.LinkedTransferQueue; * @version $Rev$, $Date$ * * @see HttpServerCodec + * + * @apiviz.has org.jboss.netty.handler.codec.http.HttpResponseDecoder + * @apiviz.has org.jboss.netty.handler.codec.http.HttpRequestEncoder */ public class HttpClientCodec implements ChannelUpstreamHandler, ChannelDownstreamHandler { diff --git a/src/main/java/org/jboss/netty/handler/codec/http/HttpServerCodec.java b/src/main/java/org/jboss/netty/handler/codec/http/HttpServerCodec.java index 32b15801e1..a133041faa 100644 --- a/src/main/java/org/jboss/netty/handler/codec/http/HttpServerCodec.java +++ b/src/main/java/org/jboss/netty/handler/codec/http/HttpServerCodec.java @@ -29,6 +29,9 @@ import org.jboss.netty.channel.ChannelUpstreamHandler; * @version $Rev$, $Date$ * * @see HttpClientCodec + * + * @apiviz.has org.jboss.netty.handler.codec.http.HttpRequestDecoder + * @apiviz.has org.jboss.netty.handler.codec.http.HttpResponseEncoder */ public class HttpServerCodec implements ChannelUpstreamHandler, ChannelDownstreamHandler { diff --git a/src/main/java/org/jboss/netty/handler/codec/http/package-info.java b/src/main/java/org/jboss/netty/handler/codec/http/package-info.java index 6dc96c60a6..487d7c48cd 100644 --- a/src/main/java/org/jboss/netty/handler/codec/http/package-info.java +++ b/src/main/java/org/jboss/netty/handler/codec/http/package-info.java @@ -19,9 +19,11 @@ * * @apiviz.exclude ^java\.lang\. * @apiviz.exclude OneToOne(Encoder|Decoder)$ - * @apiviz.exclude HttpHeaders - * @apiviz.exclude (QueryString|Cookie)(Encoder|Decoder)$ + * @apiviz.exclude \.HttpHeaders\. * @apiviz.exclude \.codec\.replay\. * @apiviz.exclude \.(Simple)?Channel[A-Za-z]*Handler$ + * @apiviz.exclude \.Rtsp + * @apiviz.exclude \.Default + * @apiviz.exclude \.Http(Client|Server)Codec$ */ package org.jboss.netty.handler.codec.http;