NIFI-259: Fixed checkstyle violations

This commit is contained in:
Mark Payne 2016-01-13 13:57:47 -05:00
parent d39067ede6
commit 0151b1eed1
11 changed files with 16 additions and 16 deletions

View File

@ -44,15 +44,11 @@ import org.apache.nifi.components.state.StateManager;
public @interface Stateful {
/**
* Provides a description of what information is being stored in the {@link StateManager}
*
* @return a description of what information is being stored in the {@link StateManager}
*/
String description();
/**
* Indicates the Scope(s) associated with the State that is stored and retrieved.
*
* @return
*/
Scope[]scopes();
}

View File

@ -69,8 +69,8 @@ public interface StateManager {
* If the state has not yet been set, the StateMap's version will be -1, and the map of values will be empty.
*
* @param scope the scope to use when fetching the state
* @return
* @throws IOException
* @return the current state for the component
* @throws IOException if unable to communicate with the underlying storage mechanism
*/
StateMap getState(Scope scope) throws IOException;

View File

@ -35,7 +35,7 @@ public interface StateMap {
/**
* Returns the value associated with the given key
*
*
* @param key the key whose value should be retrieved
* @return the value associated with the given key, or <code>null</code> if no value is associated
* with this key.

View File

@ -25,7 +25,6 @@ import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import org.apache.nifi.components.state.StateManager;
import org.apache.nifi.controller.queue.QueueSize;
import org.apache.nifi.flowfile.FlowFile;
import org.apache.nifi.processor.exception.FlowFileAccessException;

View File

@ -548,6 +548,11 @@ We can initialize our Kerberos ticket by running the following command:
[source]
kinit nifi
Note, the above `kinit` command requires that Kerberos client libraries be installed. This is accomplished in Fedora-based Linux distributions via:
[source]
yum install krb5-workstation krb5-libs krb5-auth-dialog
Now, when we start NiFi, it will use Kerberos to authentication as the `nifi` user when communicating with ZooKeeper.

View File

@ -798,8 +798,8 @@ public class StandardProcessorTestRunner implements TestRunner {
/**
* Returns the State Manager for the given Controller Service.
*
* @param controllerService
* @return
* @param controllerService the Controller Service whose State Manager should be returned
* @return the State Manager for the given Controller Service
*/
@Override
public MockStateManager getStateManager(final ControllerService controllerService) {

View File

@ -36,7 +36,7 @@ public interface ConfiguredComponent {
/**
* Sets the property with the given name to the given value
*
*
* @param name the name of the property to update
* @param value the value to update the property to
* @param triggerOnPropertyModified if <code>true</code>, will trigger the #onPropertyModified method of the component

View File

@ -67,7 +67,7 @@ public interface LogRepository {
/**
* Sets the current logger for the component
*
*
* @param logger the logger to use
*/
void setLogger(ComponentLog logger);

View File

@ -122,7 +122,7 @@ public final class StandardProcessScheduler implements ProcessScheduler {
/**
* Submits the given task to be executed exactly once in a background thread
*
*
* @param task the task to perform
*/
public void submitFrameworkTask(final Runnable task) {

View File

@ -89,9 +89,9 @@ public class HDFSListing {
}
/**
* Converts this HDFSListing into a Map<String, String> so that it can be stored in a StateManager.
* Converts this HDFSListing into a Map&lt;String, String&gt; so that it can be stored in a StateManager.
*
* @return a Map<String, String> that represents the same information as this HDFSListing
* @return a Map that represents the same information as this HDFSListing
*/
public Map<String, String> toMap() {
final Map<String, String> map = new HashMap<>(1 + matchingPaths.size());

View File

@ -192,7 +192,7 @@ public class TailFile extends AbstractProcessor {
* Recovers values for the State that was stored in a local file.
*
* @param context the ProcessContext that indicates where the state is stored
* @return a Map<String, String> that contains the keys defined in {@link TailFileState.StateKeys}
* @return a Map that contains the keys defined in {@link TailFileState.StateKeys}
* @throws IOException if the state file exists but was unable to be read
*/
private Map<String, String> recoverStateValuesFromFile(final ProcessContext context) throws IOException {