public final class

PropertyPermission

extends BasicPermission
java.lang.Object
   ↳ java.security.Permission
     ↳ java.security.BasicPermission
       ↳ java.util.PropertyPermission

Class Overview

PropertyPermission objects represent a permission to access system properties.

A permission is one of the possible permission strings like "user.name" or "java.version". It's also possible to use a wildcard to define the permission to several properties at once. For example "user.*" will define the permission for "user.home", "user.name", "user.dir", ... "*" defines the permission for all available properties.

There are two possible permission action types: read and write. Possible actions are "read", "write", or "read,write"/"write,read".

Summary

Public Constructors
PropertyPermission(String name, String actions)
Constructs a new instance of this class.
Public Methods
boolean equals(Object o)
Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
String getActions()
Returns the actions associated with the receiver.
int hashCode()
Returns an integer hash code for the receiver.
boolean implies(Permission permission)
Indicates whether the argument permission is implied by the receiver.
PermissionCollection newPermissionCollection()
Returns a new PermissionCollection for holding permissions of this class.
[Expand]
Inherited Methods
From class java.security.BasicPermission
From class java.security.Permission
From class java.lang.Object
From interface java.security.Guard

Public Constructors

public PropertyPermission (String name, String actions)

Since: API Level 1

Constructs a new instance of this class.

Parameters
name the (possibly wildcarded) name of the property.
actions the actions which are applicable to it. Possible actions are "read", "write", or "read,write"/"write,read". Anything else will result in an IllegalArgumentException.

Public Methods

public boolean equals (Object o)

Since: API Level 1

Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison. In this case, the receiver must be a PropertyPermission for the same property as the argument, and must have the same actions. If o is a permission that is not a PropertyPermission, this method may throw a ClassCastException.

Parameters
o the Object to compare with this Object.
Returns
  • true if the Object is the same as this Object, false if it is different from this Object.
See Also

public String getActions ()

Since: API Level 1

Returns the actions associated with the receiver. The result will be either "read", "write", or "read,write".

Returns
  • the actions associated with the receiver.

public int hashCode ()

Since: API Level 1

Returns an integer hash code for the receiver. Any two objects which return true when passed to equals must return the same value for this method.

Returns
  • the receiver's hash.
See Also

public boolean implies (Permission permission)

Since: API Level 1

Indicates whether the argument permission is implied by the receiver.

Parameters
permission the permission to check.
Returns
  • boolean true if the argument permission is implied by the receiver, and false if it is not.

public PermissionCollection newPermissionCollection ()

Since: API Level 1

Returns a new PermissionCollection for holding permissions of this class. Returns null if any PermissionCollection can be used.

Returns
  • a new PermissionCollection or null.