[
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14369736#comment-14369736
]
Dan Bress edited comment on NIFI-309 at 3/19/15 5:18 PM:
---------------------------------------------------------
Not pushing back... but now I am remembering why I did this this way in the
first place:
http://docs.oracle.com/javase/tutorial/java/annotations/repeating.html
Java8 will support repeating annotations, so we could do something like
{code:title=IdentifySomething.java|borderStyle=solid}
@ReadsAttribute(value="mime.type", description="the mime type")
@ReadsAttribute(value="file.size", description="the size of the file")
public class IdentifySomething extends AbstractProcessor
{code}
If we have "Attribute", then that doesn't specify whether its a read/write so
we couldn't simply repeat that attribute if we were to go to Java8. Probably
not reason enough to not go forward with Mark's suggestion, but I wanted to put
it out there.
was (Author: danbress):
Not pushing back... but now I am remembering why I did this this way in the
first place:
http://docs.oracle.com/javase/tutorial/java/annotations/repeating.html
Java8 will support repeating annotations, so we could do something like
{code:title=Bar.java|borderStyle=solid}
@ReadsAttribute(value="mime.type", description="the mime type")
@ReadsAttribute(value="file.size", description="the size of the file)
public class IdentifySomething extends AbstractProcessor
{code}
If we have "Attribute", then that doesn't specify whether its a read/write so
we couldn't simply repeat that attribute if we were to go to Java8. Probably
not reason enough to not go forward with Mark's suggestion, but I wanted to put
it out there.
> Support additional documentation annotations
> --------------------------------------------
>
> Key: NIFI-309
> URL: https://issues.apache.org/jira/browse/NIFI-309
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Core Framework, Documentation & Website
> Affects Versions: 0.0.1
> Reporter: Dan Bress
> Assignee: Dan Bress
> Priority: Trivial
>
> Additional documentation only annotations should be added to better describe
> ConfigurableComponents. These annotations are:
> DynamicProperties - this would indicate whether a component supports dynamic
> properties or not, and provides a description. This could be used by the UI
> to determine whether or not to allow dynamic properties. It could also be
> reflected in the documentation.
> DynamicRelationships - this would indicate whether a component has dynamic
> relationships, like RouteOnAttribute and DistributeLoad do. This could be
> reflected in the documentation.
> ReadsAttribute - indicates what attributes a Processor reads certain FlowFile
> attributes on incoming FlowFiles. This would be reflected in the
> documentation.
> WritesAttribute - indicates what attributes a Processor creates on outgoing
> FlowFile attributes. This would be reflected in the documentation.
> SeeAlso - Provides a mechanism to link one configurable component to another.
> E.g. PutFile & GetFile. This would be used in the documentation.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
