public class UserParameter extends FIPAWord implements Comparable<UserParameter>, Identifier
User-defined parameters for messages.
The key of a user-defined parameter must start with "X-", must not be empty
apart from the "X-", and must be a FIPAWord
. If the parameter does
not start with "X-", the "X-" is prepended by the constructor. If the other
requirements are not met, the constructor throws an
IllegalArgumentException
. This behavior is intended to make the user
recognise mistakes early.
Modifier and Type | Field and Description |
---|---|
static String |
PREFIX
User parameter prefix "X-"
|
Constructor and Description |
---|
UserParameter(String key)
Constructs a new user-defined parameter key for messages.
|
public static final String PREFIX
public UserParameter(String key)
key
- the user-defined parameter keyIllegalArgumentException
- if the key is empty apart from the "X-"IllegalArgumentException
- if the key is not a FIPAWord
public int compareTo(UserParameter other)
compareTo
in interface Comparable<UserParameter>
Copyright © Aimpulse Intelligent Systems GmbH
All rights reserved.