org.jmythapi.protocol.annotation
Annotation Type MythProtoVersionMetadata

public @interface MythProtoVersionMetadata

This annotation is used to append additional metadata to a protocol-version range.

See ProtocolVersionInfo for constants, that can be used as key for this annotation.

Usage example:

In the following example we have added the SVN-Rev. and GIT-Commit ID as metadata to the lower value of the version range. This additional metadata is currently just used for documentation purposes.

    @MythProtoVersionAnnotation(from=PROTO_VERSION_15, fromInfo={
        @MythProtoVersionMetadata(key=SVN_COMMIT, value="5156"),
        @MythProtoVersionMetadata(key=GIT_COMMIT, value="e6c87e28e6e54e046882")
    })
    public abstract boolean rescheduleRecordings(Integer recordingId) throws IOException;
 

See Also:

protocol-version range, metadata constants

Required Element Summary

String	key Gets the metadata key.
String	value Gets the metadata value.

Element Detail

key

public abstract String key

Gets the metadata key.

This is one of the constants defined in ProtocolVersionInfo.

Returns:

the metadata key.

value

public abstract String value

Gets the metadata value.

Returns:

the metadata value.