org.jdiameter.api.annotation
Annotation Type AvpDscr

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface AvpDscr

This annotation allows describe Java POJO object as Diameter avp element

Author:

erick.svenson@yahoo.com, Alexandre Mendonca , Bartosz Baranowski

Required Element Summary

int	code Return avp code
AvpType	type Return avp type

Optional Element Summary

Child[]	childs Return array of avp child ( for grouped avp )
AvpFlag[]	may Return array optional flags
boolean	mayEncr Return true if the flag can be encrypted
AvpFlag[]	must Return array of mandatory flags
AvpFlag[]	mustNot Return array flags which must not be set
java.lang.String	name Return avp name
AvpFlag[]	shldNot Return array flags which should not be set
long	vendorId Return avp vendor id

Element Detail

code

public abstract int code

Return avp code

Returns:

avp code

type

public abstract AvpType type

Return avp type

Returns:

avp type

name

public abstract java.lang.String name

Return avp name

Returns:

avp name

Default:

"unknown"

vendorId

public abstract long vendorId

Return avp vendor id

Returns:

avp vendor id

Default:

0L

must

public abstract AvpFlag[] must

Return array of mandatory flags

Returns:

array of mandatory flags

Default:

{}

may

public abstract AvpFlag[] may

Return array optional flags

Returns:

array optional flags

Default:

{}

shldNot

public abstract AvpFlag[] shldNot

Return array flags which should not be set

Returns:

array flags which should not be set

Default:

{}

mustNot

public abstract AvpFlag[] mustNot

Return array flags which must not be set

Returns:

array flags which must not be set

Default:

{}

mayEncr

public abstract boolean mayEncr

Return true if the flag can be encrypted

Returns:

true if the flag can be encrypted

Default:

false

childs

public abstract Child[] childs

Return array of avp child ( for grouped avp )

Returns:

array of avp child

Default:

{}