OSGi 8.1.0 · org.osgi.service.condpermadmin.ConditionInfo

Condition representation used by the Conditional Permission Admin service.

This class encapsulates two pieces of information: a Condition type (class name), which must implement Condition, and the arguments passed to its constructor.

In order for a Condition represented by a ConditionInfo to be instantiated and considered during a permission check, its Condition class must be available from the system classpath.

The Condition class must either:

Declare a public static getCondition method that takes a Bundle object and a ConditionInfo object as arguments. That method must return an object that implements the Condition interface.
Implement the Condition interface and define a public constructor that takes a Bundle object and a ConditionInfo object as arguments.

Field Summary

Modifier and Type	Field and Description
private final String[]	args
private final String	type

Constructor Summary

Access	Constructor and Description
public	ConditionInfo(String The fully qualified class name of the Condition represented by this `ConditionInfo`. type, String[] The arguments for the Condition. These arguments are available to the newly created Condition by calling the `getArgs()` method. args) Constructs a `ConditionInfo` from the specified type and args.
public	ConditionInfo(String The encoded `ConditionInfo`. encodedCondition) Constructs a `ConditionInfo` object from the specified encoded `ConditionInfo` string.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `obj` is a `ConditionInfo`, and has the same type and args as this `ConditionInfo` object; `false` otherwise. equals(Object The object to test for equality with this `ConditionInfo` object. obj) Overrides java.lang.Object.equals. Determines the equality of two `ConditionInfo` objects.
private static void	escapeString(String str, StringBuilder output) This escapes the quotes, backslashes, \n, and \r in the string using a backslash and appends the newly escaped string to a StringBuilder.
public final String[]	Returns: The arguments of this `ConditionInfo`. An empty array is returned if the `ConditionInfo` has no arguments. getArgs() Returns arguments of this `ConditionInfo`.
public final String	Returns: The string encoding of this `ConditionInfo`. getEncoded() Returns the string encoding of this `ConditionInfo` in a form suitable for restoring this `ConditionInfo`.
public final String	Returns: The fully qualified class name of the condition represented by this `ConditionInfo`. getType() Returns the fully qualified class name of the condition represented by this `ConditionInfo`.
public int	Returns: A hash code value for this object. hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this object.
public String	Returns: The string representation of this `ConditionInfo`. toString() Overrides java.lang.Object.toString. Returns the string representation of this `ConditionInfo`.
private static String	unescapeString(char[] str, int begin, int end) Takes an encoded character array and decodes it into a new String.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

args	back to summary
private final String[] args

type	back to summary
private final String type

Constructor Detail

ConditionInfo back to summary

ConditionInfo	back to summary
public ConditionInfo(String type, String[] args) Constructs a `ConditionInfo` from the specified type and args. Parameters type:String The fully qualified class name of the Condition represented by this `ConditionInfo`. args:String[] The arguments for the Condition. These arguments are available to the newly created Condition by calling the `getArgs()` method. Exceptions NullPointerException: If `type` is `null`.

public ConditionInfo(String type, String[] args)

Constructs a ConditionInfo from the specified type and args.

Parameters

type:String: The fully qualified class name of the Condition represented by this ConditionInfo.
args:String[]: The arguments for the Condition. These arguments are available to the newly created Condition by calling the getArgs() method.

Exceptions

NullPointerException:: If type is null.

ConditionInfo back to summary

ConditionInfo	back to summary
public ConditionInfo(String encodedCondition) Constructs a `ConditionInfo` object from the specified encoded `ConditionInfo` string. White space in the encoded `ConditionInfo` string is ignored. Parameters encodedCondition:String The encoded `ConditionInfo`. Exceptions IllegalArgumentException: If the specified `encodedCondition` is not properly formatted. See Also `getEncoded()`

public ConditionInfo(String encodedCondition)

Constructs a ConditionInfo object from the specified encoded ConditionInfo string. White space in the encoded ConditionInfo string is ignored.

Parameters

encodedCondition:String: The encoded ConditionInfo.

Exceptions

IllegalArgumentException:: If the specified encodedCondition is not properly formatted.

See Also

getEncoded()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Determines the equality of two `ConditionInfo` objects. This method checks that specified object has the same type and args as this `ConditionInfo` object. Parameters obj:Object The object to test for equality with this `ConditionInfo` object. Returns:boolean `true` if `obj` is a `ConditionInfo`, and has the same type and args as this `ConditionInfo` object; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Determines the equality of two ConditionInfo objects. This method checks that specified object has the same type and args as this ConditionInfo object.

Parameters

obj:Object: The object to test for equality with this ConditionInfo object.

Returns:boolean

true if obj is a ConditionInfo, and has the same type and args as this ConditionInfo object; false otherwise.

Annotations

@Override

escapeString	back to summary
private static void escapeString(String str, StringBuilder output) This escapes the quotes, backslashes, \n, and \r in the string using a backslash and appends the newly escaped string to a StringBuilder.

getArgs back to summary

getArgs	back to summary
public final String[] getArgs() Returns arguments of this `ConditionInfo`. Returns:String[] The arguments of this `ConditionInfo`. An empty array is returned if the `ConditionInfo` has no arguments.

public final String[] getArgs()

Returns arguments of this ConditionInfo.

Returns:String[]: The arguments of this ConditionInfo. An empty array is returned if the ConditionInfo has no arguments.

getEncoded back to summary

getEncoded	back to summary
public final String getEncoded() Returns the string encoding of this `ConditionInfo` in a form suitable for restoring this `ConditionInfo`. The encoded format is: [type "arg0" "arg1" ...] where argN are strings that must be encoded for proper parsing. Specifically, the `"`, `\`, carriage return, and line feed characters must be escaped using `\"`, `\\`, `\r`, and `\n`, respectively. The encoded string contains no leading or trailing whitespace characters. A single space character is used between type and "arg0" and between the arguments. Returns:String The string encoding of this `ConditionInfo`.

public final String getEncoded()

Returns the string encoding of this ConditionInfo in a form suitable for restoring this ConditionInfo.

The encoded format is:

  [type "arg0" "arg1" ...]

where argN are strings that must be encoded for proper parsing. Specifically, the ", \, carriage return, and line feed characters must be escaped using \", \\, \r, and \n, respectively.

The encoded string contains no leading or trailing whitespace characters. A single space character is used between type and "arg0" and between the arguments.

Returns:String: The string encoding of this ConditionInfo.

getType back to summary

getType	back to summary
public final String getType() Returns the fully qualified class name of the condition represented by this `ConditionInfo`. Returns:String The fully qualified class name of the condition represented by this `ConditionInfo`.

public final String getType()

Returns the fully qualified class name of the condition represented by this ConditionInfo.

Returns:String: The fully qualified class name of the condition represented by this ConditionInfo.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns the hash code value for this object. Returns:int A hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hash code value for this object.

Returns:int

A hash code value for this object.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string representation of this `ConditionInfo`. The string is created by calling the `getEncoded` method on this `ConditionInfo`. Returns:String The string representation of this `ConditionInfo`. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this ConditionInfo. The string is created by calling the getEncoded method on this ConditionInfo.

Returns:String

The string representation of this ConditionInfo.

Annotations

@Override

unescapeString	back to summary
private static String unescapeString(char[] str, int begin, int end) Takes an encoded character array and decodes it into a new String.

public Class ConditionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail