You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@flume.apache.org by Mike Percy <mp...@gmail.com> on 2012/03/08 12:45:11 UTC

Review Request: FLUME-1021: Document additional interface contracts, including Source

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/4240/
-----------------------------------------------------------

Review request for Flume.


Summary
-------

Adding additional javadoc documentation for interfaces.

The hope is to clarify various API contracts as well as to lower the barrier to entry to the system for new developers.

These are only Javadoc comments. No lines of executable code have been changed.


This addresses bug FLUME-1021.
    https://issues.apache.org/jira/browse/FLUME-1021


Diffs
-----

  flume-ng-core/src/main/java/org/apache/flume/Channel.java b719220 
  flume-ng-core/src/main/java/org/apache/flume/Context.java a6341a5 
  flume-ng-core/src/main/java/org/apache/flume/CounterGroup.java 258805c 
  flume-ng-core/src/main/java/org/apache/flume/Event.java a017705 
  flume-ng-core/src/main/java/org/apache/flume/EventDeliveryException.java d3dbb79 
  flume-ng-core/src/main/java/org/apache/flume/EventDrivenSource.java 6ceaf69 
  flume-ng-core/src/main/java/org/apache/flume/NamedComponent.java 1a65fe7 
  flume-ng-core/src/main/java/org/apache/flume/PollableSource.java 663315a 
  flume-ng-core/src/main/java/org/apache/flume/SinkRunner.java 9e46d87 
  flume-ng-core/src/main/java/org/apache/flume/Source.java ce2bbba 
  flume-ng-core/src/main/java/org/apache/flume/SourceRunner.java ef65650 
  flume-ng-core/src/main/java/org/apache/flume/channel/ChannelProcessor.java 104313b 
  flume-ng-core/src/main/java/org/apache/flume/source/EventDrivenSourceRunner.java 3baa6b3 

Diff: https://reviews.apache.org/r/4240/diff


Testing
-------


Thanks,

Mike


Re: Review Request: FLUME-1021: Document additional interface contracts, including Source

Posted by Arvind Prabhakar <ar...@apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/4240/#review5740
-----------------------------------------------------------

Ship it!


+1. Please incorporate the following feedback and upload the patch to the Jira for commit. Thanks for taking the time to do this.


flume-ng-core/src/main/java/org/apache/flume/PollableSource.java
<https://reviews.apache.org/r/4240/#comment12490>

    trailing whitespace.



flume-ng-core/src/main/java/org/apache/flume/Source.java
<https://reviews.apache.org/r/4240/#comment12491>

    into configured {@link Channel}s (plural)


- Arvind


On 2012-03-08 11:45:11, Mike Percy wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/4240/
> -----------------------------------------------------------
> 
> (Updated 2012-03-08 11:45:11)
> 
> 
> Review request for Flume.
> 
> 
> Summary
> -------
> 
> Adding additional javadoc documentation for interfaces.
> 
> The hope is to clarify various API contracts as well as to lower the barrier to entry to the system for new developers.
> 
> These are only Javadoc comments. No lines of executable code have been changed.
> 
> 
> This addresses bug FLUME-1021.
>     https://issues.apache.org/jira/browse/FLUME-1021
> 
> 
> Diffs
> -----
> 
>   flume-ng-core/src/main/java/org/apache/flume/Channel.java b719220 
>   flume-ng-core/src/main/java/org/apache/flume/Context.java a6341a5 
>   flume-ng-core/src/main/java/org/apache/flume/CounterGroup.java 258805c 
>   flume-ng-core/src/main/java/org/apache/flume/Event.java a017705 
>   flume-ng-core/src/main/java/org/apache/flume/EventDeliveryException.java d3dbb79 
>   flume-ng-core/src/main/java/org/apache/flume/EventDrivenSource.java 6ceaf69 
>   flume-ng-core/src/main/java/org/apache/flume/NamedComponent.java 1a65fe7 
>   flume-ng-core/src/main/java/org/apache/flume/PollableSource.java 663315a 
>   flume-ng-core/src/main/java/org/apache/flume/SinkRunner.java 9e46d87 
>   flume-ng-core/src/main/java/org/apache/flume/Source.java ce2bbba 
>   flume-ng-core/src/main/java/org/apache/flume/SourceRunner.java ef65650 
>   flume-ng-core/src/main/java/org/apache/flume/channel/ChannelProcessor.java 104313b 
>   flume-ng-core/src/main/java/org/apache/flume/source/EventDrivenSourceRunner.java 3baa6b3 
> 
> Diff: https://reviews.apache.org/r/4240/diff
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Mike
> 
>