org.codehaus.groovy.grails.support.encoding

Interface CodecIdentifier

All Known Implementing Classes:

CombinedCodecIdentifier, DefaultCodecIdentifier

public interface CodecIdentifier

Information about the codec that identifies it and tells it's aliases.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getCodecAliases() Gets the aliases for this codec.
java.lang.String	getCodecName() Gets the unique name of the codec.
boolean	isEquivalent(CodecIdentifier other) Checks if this codec is equivalent to some other codec

Method Detail

getCodecName

java.lang.String getCodecName()

Gets the unique name of the codec.

Returns:

the codec name

getCodecAliases

java.util.Set<java.lang.String> getCodecAliases()

Gets the aliases for this codec. Aliases are used in registering "encodeAs*" and "decode*" metamethods in org.codehaus.groovy.grails.commons.DefaultGrailsCodecClass

Returns:

the codec aliases

isEquivalent

boolean isEquivalent(CodecIdentifier other)

Checks if this codec is equivalent to some other codec

Parameters:

other - the CodecIdentifier of the other codec

Returns:

true, if is equivalent