Interface Protocol
-
- All Known Implementing Classes:
FileProtocol
public interface ProtocolDefinition of a protocol- Author:
- Brian Wyka, Christian Oestreich
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()An optional description for the protocolStringgetName()The name of the protocolStringgetSeverity()The severity of the protocolString[]getTags()Any tags that the protocol should be annotated withbooleanisRequired()Whether or not the protocol is required
-
-
-
Method Detail
-
getName
String getName()
The name of the protocol- Returns:
- the name
-
getDescription
String getDescription()
An optional description for the protocol- Returns:
- the description
-
getTags
String[] getTags()
Any tags that the protocol should be annotated with- Returns:
- the tags
-
isRequired
boolean isRequired()
Whether or not the protocol is required- Returns:
- true if required, false otherwise
-
getSeverity
String getSeverity()
The severity of the protocol- Returns:
- the severity
-
-