Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Commit for NIFI-836 to fix broken javadoc @link elements 

Signed-off-by: Matt Gilman <matt.c.gilman@gmail.com>
This commit is contained in:
Joseph Percivall 2015-09-09 16:50:25 -04:00 committed by Matt Gilman
parent 9dae76b9c4
commit a83ed34f91
15 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java
View File

@ -27,14 +27,14 @@ import java.lang.annotation.Target;
* Marker annotation a Processor implementation can use to indicate that users
* should be able to supply a Batch Duration for the Processor. If a Processor
* uses this annotation, it is allowing the Framework to batch
* {@link nifi.processor.ProcessSession ProcessSession}s' commits, as well as
* {@link org.apache.nifi.processor.ProcessSession ProcessSession}s' commits, as well as
* allowing the Framework to return the same ProcessSession multiple times from
* subsequent calls to
* {@link nifi.processor.ProcessSessionFactory ProcessSessionFactory}.
* {@link nifi.processor.ProcessSessionFactory#createSession() createSession()}.
* {@link org.apache.nifi.processor.ProcessSessionFactory ProcessSessionFactory}.
* {@link org.apache.nifi.processor.ProcessSessionFactory#createSession() createSession()}.
*
* When this Annotation is used, it is important to note that calls to
* {@link nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
* {@link org.apache.nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
* not provide a guarantee that the data has been safely stored in NiFi's
* Content Repository or FlowFile Repository. Therefore, it is not appropriate,
* for instance, to use this annotation if the Processor will call

2
nifi-api/src/main/java/org/apache/nifi/controller/annotation/OnConfigured.java
View File

@ -28,7 +28,7 @@ import java.lang.annotation.Target;
* method should be called after all of the properties have been set for the
* Controller Service. Methods using this annotation must take either 0
* arguments or a single argument of type
* {@link nifi.controller.ConfigurationContext ConfigurationContext}.
* {@link org.apache.nifi.controller.ConfigurationContext ConfigurationContext}.
*
*
* @deprecated This annotation has been replaced by those in the

2
nifi-api/src/main/java/org/apache/nifi/controller/repository/FlowFileRecord.java
View File

@ -42,7 +42,7 @@ public interface FlowFileRecord extends FlowFile {
* FlowFile's content occurs. This mechanism allows multiple FlowFiles to
* have the same ContentClaim, which can be significantly more efficient for
* some implementations of
* {@link nifi.controller.repository.ContentRepository ContentRepository}
* {@link org.apache.nifi.controller.repository.ContentRepository ContentRepository}
*/
long getContentClaimOffset();
}

2
nifi-api/src/main/java/org/apache/nifi/processor/ProcessorInitializationContext.java
View File

@ -22,7 +22,7 @@ import org.apache.nifi.logging.ProcessorLog;
/**
* <p>
* The <code>ProcessorInitializationContext</code> provides
* {@link nifi.processor.Processor Processor}s access to objects that may be of
* {@link org.apache.nifi.processor.Processor Processor}s access to objects that may be of
* use throughout the life of the Processor.
* </p>
*/

2
nifi-api/src/main/java/org/apache/nifi/processor/annotation/OnScheduled.java
View File

@ -29,7 +29,7 @@ import java.lang.annotation.Target;
* will be called before any 'onTrigger' calls and will be called once each time
* a processor instance is scheduled to run. Methods using this annotation must
* take either 0 arguments or a single argument of type
* {@link nifi.processor.SchedulingContext SchedulingContext}.
* {@link org.apache.nifi.processor.SchedulingContext SchedulingContext}.
*
* If any method annotated with this annotation throws, the processor will not
* be scheduled to run.

6
nifi-api/src/main/java/org/apache/nifi/processor/annotation/SupportsBatching.java
View File

@ -27,13 +27,13 @@ import java.lang.annotation.Target;
* Marker annotation a Processor implementation can use to indicate that users
* should be able to supply a Batch Duration for the Processor. If a Processor
* uses this annotation, it is allowing the Framework to batch
* {@link nifi.processor.ProcessSession ProcessSession}s' commits, as well as
* {@link org.apache.nifi.processor.ProcessSession ProcessSession}s' commits, as well as
* allowing the Framework to return the same ProcessSession multiple times from
* subsequent calls to
* {@link nifi.processor.ProcessSessionFactory ProcessSessionFactory}.{@link nifi.processor.ProcessSessionFactory#createSession() createSession()}.
* {@link org.apache.nifi.processor.ProcessSessionFactory ProcessSessionFactory}.{@link org.apache.nifi.processor.ProcessSessionFactory#createSession() createSession()}.
*
* When this Annotation is used, it is important to note that calls to
* {@link nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
* {@link org.apache.nifi.processor.ProcessSession#commit() ProcessSession.commit()} may
* not provide a guarantee that the data has been safely stored in NiFi's
* Content Repository or FlowFile Repository. Therefore, it is not appropriate,
* for instance, to use this annotation if the Processor will call

2
nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
View File

@ -71,7 +71,7 @@ public enum ProvenanceEventType {
ATTRIBUTES_MODIFIED,
/**
* ROUTE is used to show that a FlowFile was routed to a specified
* {@link nifi.processor.Relationship Relationship} and should provide
* {@link org.apache.nifi.processor.Relationship Relationship} and should provide
* information about why the FlowFile was routed to this relationship.
*/
ROUTE,

8
nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceReporter.java
View File

@ -205,7 +205,7 @@ public interface ProvenanceReporter {
* correlate the SEND and RECEIVE events.
* @param force if <code>true</code>, this event will be added to the
* Provenance Repository immediately and will still be persisted if the
* {@link nifi.processor.ProcessSession ProcessSession} to which this
* {@link org.apache.nifi.processor.ProcessSession ProcessSession} to which this
* ProvenanceReporter is associated is rolled back. Otherwise, the Event
* will be recorded only on a successful session commit.
*/
@ -227,7 +227,7 @@ public interface ProvenanceReporter {
* remote system's Distinguished Name
* @param force if <code>true</code>, this event will be added to the
* Provenance Repository immediately and will still be persisted if the
* {@link nifi.processor.ProcessSession ProcessSession} to which this
* {@link org.apache.nifi.processor.ProcessSession ProcessSession} to which this
* ProvenanceReporter is associated is rolled back. Otherwise, the Event
* will be recorded only on a successful session commit.
*/
@ -249,7 +249,7 @@ public interface ProvenanceReporter {
* data to the remote system
* @param force if <code>true</code>, this event will be added to the
* Provenance Repository immediately and will still be persisted if the
* {@link nifi.processor.ProcessSession ProcessSession} to which this
* {@link org.apache.nifi.processor.ProcessSession ProcessSession} to which this
* ProvenanceReporter is associated is rolled back. Otherwise, the Event
* will be recorded only on a successful session commit.
*/
@ -273,7 +273,7 @@ public interface ProvenanceReporter {
* data to the remote system
* @param force if <code>true</code>, this event will be added to the
* Provenance Repository immediately and will still be persisted if the
* {@link nifi.processor.ProcessSession ProcessSession} to which this
* {@link org.apache.nifi.processor.ProcessSession ProcessSession} to which this
* ProvenanceReporter is associated is rolled back. Otherwise, the Event
* will be recorded only on a successful session commit.
*/

4
nifi-mock/src/main/java/org/apache/nifi/util/MockProcessSession.java
View File

@ -141,7 +141,7 @@ public class MockProcessSession implements ProcessSession {
/**
* Clear the 'committed' flag so that we can test that the next iteration of
* {@link nifi.processor.Processor#onTrigger} commits or rolls back the
* {@link org.apache.nifi.processor.Processor#onTrigger} commits or rolls back the
* session
*/
public void clearCommited() {
@ -150,7 +150,7 @@ public class MockProcessSession implements ProcessSession {
/**
* Clear the 'rolledBack' flag so that we can test that the next iteration
* of {@link nifi.processor.Processor#onTrigger} commits or rolls back the
* of {@link org.apache.nifi.processor.Processor#onTrigger} commits or rolls back the
* session
*/
public void clearRollback() {

38
nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java
View File

@ -74,7 +74,7 @@ public interface TestRunner {
void run(int iterations);
/**
* performs the same operation as calling {@link #run(int, boolean, int)}
* performs the same operation as calling {@link #run(int, boolean, boolean)}
* with a value of {@code iterations}, {@code stopOnFinish}, {@code true}
*
* @param iterations number of iterations
@ -89,7 +89,7 @@ public interface TestRunner {
* <li>
* If {@code initialize} is true, run all methods on the Processor that are
* annotated with the
* {@link nifi.processor.annotation.OnScheduled @OnScheduled} annotation. If
* {@link org.apache.nifi.processor.annotation.OnScheduled @OnScheduled} annotation. If
* any of these methods throws an Exception, the Unit Test will fail.
* </li>
* <li>
@ -104,7 +104,7 @@ public interface TestRunner {
* As soon as the first thread finishes its execution of
* {@link Processor#onTrigger(ProcessContext, ProcessSessionFactory) onTrigger},
* all methods on the Processor that are annotated with the
* {@link nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
* {@link org.apache.nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
* are invoked. If any of these methods throws an Exception, the Unit Test
* will fail.
* </li>
@ -114,13 +114,13 @@ public interface TestRunner {
* <li>
* If and only if the value of <code>shutdown</code> is true: Call all
* methods on the Processor that is annotated with the
* {@link nifi.processor.annotation.OnStopped @OnStopped} annotation.
* {@link org.apache.nifi.processor.annotation.OnStopped @OnStopped} annotation.
* </li>
* </ul>
*
* @param iterations number of iterations
* @param stopOnFinish whether or not to run the Processor methods that are
* annotated with {@link nifi.processor.annotation.OnStopped @OnStopped}
* annotated with {@link org.apache.nifi.processor.annotation.OnStopped @OnStopped}
* @param initialize true if must initialize
*/
void run(int iterations, boolean stopOnFinish, final boolean initialize);
@ -132,7 +132,7 @@ public interface TestRunner {
* <li>
* If {@code initialize} is true, run all methods on the Processor that are
* annotated with the
* {@link nifi.processor.annotation.OnScheduled @OnScheduled} annotation. If
* {@link org.apache.nifi.processor.annotation.OnScheduled @OnScheduled} annotation. If
* any of these methods throws an Exception, the Unit Test will fail.
* </li>
* <li>
@ -147,7 +147,7 @@ public interface TestRunner {
* As soon as the first thread finishes its execution of
* {@link Processor#onTrigger(ProcessContext, ProcessSessionFactory) onTrigger},
* all methods on the Processor that are annotated with the
* {@link nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
* {@link org.apache.nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
* are invoked. If any of these methods throws an Exception, the Unit Test
* will fail.
* </li>
@ -157,22 +157,22 @@ public interface TestRunner {
* <li>
* If and only if the value of <code>shutdown</code> is true: Call all
* methods on the Processor that is annotated with the
* {@link nifi.processor.annotation.OnStopped @OnStopped} annotation.
* {@link org.apache.nifi.processor.annotation.OnStopped @OnStopped} annotation.
* </li>
* </ul>
*
* @param iterations number of iterations
* @param stopOnFinish whether or not to run the Processor methods that are
* annotated with {@link nifi.processor.annotation.OnStopped @OnStopped}
* annotated with {@link org.apache.nifi.processor.annotation.OnStopped @OnStopped}
* @param initialize true if must initialize
* @param runWait indicates the amount of time in milliseconds that the framework should wait for
* processors to stop running before calling the {@link nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
* processors to stop running before calling the {@link org.apache.nifi.processor.annotation.OnUnscheduled @OnUnscheduled} annotation
*/
void run(int iterations, boolean stopOnFinish, final boolean initialize, final long runWait);
/**
* Invokes all methods on the Processor that are annotated with the
* {@link nifi.processor.annotation.OnShutdown @OnShutdown} annotation. If
* {@link org.apache.nifi.processor.annotation.OnShutdown @OnShutdown} annotation. If
* any of these methods throws an Exception, the Unit Test will fail
*/
void shutdown();
@ -447,7 +447,7 @@ public interface TestRunner {
* considered "available", meaning that the queues of all Connections that
* contain this Relationship are not full. This is generally used only when
* dealing with Processors that use the
* {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* {@link org.apache.nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* annotation.
*
* @param relationship to mark as available
@ -459,7 +459,7 @@ public interface TestRunner {
* name should be considered "available", meaning that the queues of all
* Connections that contain this Relationship are not full. This is
* generally used only when dealing with Processors that use the
* {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* {@link org.apache.nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
*
* @param relationshipName relationship name
*/
@ -470,7 +470,7 @@ public interface TestRunner {
* considered "available", meaning that the queue of at least one Connection
* that contain this Relationship is full. This is generally used only when
* dealing with Processors that use the
* {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* {@link org.apache.nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* annotation.
*
* @param relationship to mark as unavailable
@ -482,7 +482,7 @@ public interface TestRunner {
* should NOT be considered "available", meaning that the queue of at least
* one Connection that contain this Relationship is full. This is generally
* used only when dealing with Processors that use the
* {@link nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
* {@link org.apache.nifi.processor.annotation.TriggerWhenAnyDestinationAvailable}
*
* @param relationshipName name of relationship.
*/
@ -493,7 +493,7 @@ public interface TestRunner {
* configured Processor can access it using the given
* <code>identifier</code>. The ControllerService is not expected to be
* initialized, as the framework will create the appropriate
* {@link nifi.controller.ControllerServiceInitializationContext ControllerServiceInitializationContext}
* {@link org.apache.nifi.controller.ControllerServiceInitializationContext ControllerServiceInitializationContext}
* and initialize the ControllerService with no specified properties.
*
* This will call any method on the given Controller Service that is
@ -511,7 +511,7 @@ public interface TestRunner {
* configured Processor can access it using the given
* <code>identifier</code>. The ControllerService is not expected to be
* initialized, as the framework will create the appropriate
* {@link nifi.controller.ControllerServiceInitializationContext ControllerServiceInitializationContext}
* {@link org.apache.nifi.controller.ControllerServiceInitializationContext ControllerServiceInitializationContext}
* and initialize the ControllerService with the given properties.
*
* This will call any method on the given Controller Service that is
@ -725,9 +725,9 @@ public interface TestRunner {
* Expression Language. By default, the value is <code>true</code>, which
* means that an Exception will be thrown if the Processor attempts to
* obtain the configured value of a Property without calling
* {@link nifi.components.PropertyValue#evaluateAttributeExpressions evaluateAttributeExpressions}
* {@link org.apache.nifi.components.PropertyValue#evaluateAttributeExpressions evaluateAttributeExpressions}
* on the Property Value or if
* {@link nifi.components.PropertyValue#evaluateAttributeExpressions evaluateAttributeExpressions}
* {@link org.apache.nifi.components.PropertyValue#evaluateAttributeExpressions evaluateAttributeExpressions}
* is called but the PropertyDescriptor indicates that the Expression
* Language is not supported.
*

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/connectable/Connectable.java
View File

@ -144,7 +144,7 @@ public interface Connectable extends Triggerable {
/**
* @return If true,
* {@link #onTrigger(nifi.processor.ProcessContext, nifi.processor.ProcessSessionFactory)}
* {@link #onTrigger(org.apache.nifi.processor.ProcessContext, org.apache.nifi.processor.ProcessSessionFactory)}
* should be called even when this Connectable has no FlowFiles queued for
* processing
*/
@ -196,13 +196,13 @@ public interface Connectable extends Triggerable {
/**
* @param timeUnit unit over which to interpret the duration
* @return the amount of time for which a FlowFile should be penalized when
* {@link ProcessSession#penalize(nifi.flowfile.FlowFile)} is called
* {@link ProcessSession#penalize(org.apache.nifi.flowfile.FlowFile)} is called
*/
long getPenalizationPeriod(final TimeUnit timeUnit);
/**
* @return a string representation for which a FlowFile should be penalized
* when {@link ProcessSession#penalize(nifi.flowfile.FlowFile)} is called
* when {@link ProcessSession#penalize(org.apache.nifi.flowfile.FlowFile)} is called
*/
String getPenalizationPeriod();
@ -222,7 +222,7 @@ public interface Connectable extends Triggerable {
/**
* Updates the amount of time that this Connectable should avoid being
* scheduled when the processor calls
* {@link nifi.processor.ProcessContext#yield() ProcessContext.yield()}
* {@link org.apache.nifi.processor.ProcessContext#yield() ProcessContext.yield()}
*
* @param yieldPeriod new yield period
*/
@ -230,7 +230,7 @@ public interface Connectable extends Triggerable {
/**
* Updates the amount of time that this Connectable will penalize FlowFiles
* when {@link ProcessSession#penalize(nifi.flowfile.FlowFile)} is called
* when {@link ProcessSession#penalize(org.apache.nifi.flowfile.FlowFile)} is called
*
* @param penalizationPeriod new period
*/
@ -240,7 +240,7 @@ public interface Connectable extends Triggerable {
* Causes the processor not to be scheduled for some period of time. This
* duration can be obtained and set via the
* {@link #getYieldPeriod(TimeUnit)} and
* {@link #setYieldPeriod(long, TimeUnit)} methods.
* {@link #setYieldPeriod(String yieldPeriod)} methods.
*/
void yield();

8
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ProcessScheduler.java
View File

@ -33,8 +33,8 @@ public interface ProcessScheduler {
/**
* Starts scheduling the given processor to run after invoking all methods
* on the underlying {@link nifi.processor.Processor FlowFileProcessor} that
* are annotated with the {@link OnScheduled} annotation. If the Processor
* on the underlying {@link org.apache.nifi.processor.Processor FlowFileProcessor} that
* are annotated with the {@link org.apache.nifi.annotation.lifecycle.OnScheduled} annotation. If the Processor
* is already scheduled to run, does nothing.
*
* @param procNode to start
@ -44,8 +44,8 @@ public interface ProcessScheduler {
/**
* Stops scheduling the given processor to run and invokes all methods on
* the underlying {@link nifi.processor.Processor FlowFileProcessor} that
* are annotated with the {@link OnUnscheduled} annotation. This does not
* the underlying {@link org.apache.nifi.processor.Processor FlowFileProcessor} that
* are annotated with the {@link org.apache.nifi.annotation.lifecycle.OnUnscheduled} annotation. This does not
* interrupt any threads that are currently running within the given
* Processor. If the Processor is not scheduled to run, does nothing.
*

4
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/StandardFunnel.java
View File

@ -401,7 +401,7 @@ public class StandardFunnel implements Funnel {
/**
* Updates the amount of time that this processor should avoid being
* scheduled when the processor calls
* {@link nifi.processor.ProcessContext#yield() ProcessContext.yield()}
* {@link org.apache.nifi.processor.ProcessContext#yield() ProcessContext.yield()}
*
* @param yieldPeriod new period
*/
@ -439,7 +439,7 @@ public class StandardFunnel implements Funnel {
* Causes the processor not to be scheduled for some period of time. This
* duration can be obtained and set via the
* {@link #getYieldPeriod(TimeUnit)} and
* {@link #setYieldPeriod(long, TimeUnit)} methods.
* {@link #setYieldPeriod(String)} methods.
*/
@Override
public void yield() {

2
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/groups/ProcessGroup.java
View File

@ -328,7 +328,7 @@ public interface ProcessGroup {
* Removes the given processor from this group, destroying the Processor.
* The Processor is removed from the ProcessorRegistry, and any method in
* the Processor that is annotated with the
* {@link nifi.processor.annotation.OnRemoved OnRemoved} annotation will be
* {@link org.apache.nifi.processor.annotation.OnRemoved OnRemoved} annotation will be
* invoked. All outgoing connections will also be destroyed
*
* @param processor the Processor to remove

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java
View File

@ -278,7 +278,7 @@ public final class StandardProcessScheduler implements ProcessScheduler {
}
/**
* Starts scheduling the given processor to run after invoking all methods on the underlying {@link nifi.processor.Processor
* Starts scheduling the given processor to run after invoking all methods on the underlying {@link org.apache.nifi.processor.Processor
* FlowFileProcessor} that are annotated with the {@link OnScheduled} annotation.
*/
@Override
@ -406,8 +406,8 @@ public final class StandardProcessScheduler implements ProcessScheduler {
}
/**
* Stops scheduling the given processor to run and invokes all methods on the underlying {@link nifi.processor.Processor FlowFileProcessor} that are annotated with the {@link OnUnscheduled}
* annotation.
* Stops scheduling the given processor to run and invokes all methods on the underlying {@link org.apache.nifi.processor.Processor FlowFileProcessor} that are annotated with the
* {@link OnUnscheduled} annotation.
*/
@Override
public synchronized void stopProcessor(final ProcessorNode procNode) {