Keycloak Core 24.0.0 · org.keycloak.representations.idm.authorization.ScopeRepresentation

Modifier and Type	Field and Description
private String	displayName
private String	iconUri
private String	id
private String	name
private List<PolicyRepresentation>	policies
private List<ResourceRepresentation>	resources

Access	Constructor and Description
public	ScopeRepresentation(String the a human-readable string describing some scope (extent) of access name, String a `URI` for a graphic icon representing the scope iconUri) Creates an instance.
public	ScopeRepresentation(String the a human-readable string describing some scope (extent) of access name) Creates an instance.
public	ScopeRepresentation() Creates an instance.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getDisplayName()
public String	getIconUri()
public String	getId()
public String	getName()
public List<PolicyRepresentation>	getPolicies()
public List<ResourceRepresentation>	getResources()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public void	setDisplayName(String displayName)
public void	setIconUri(String iconUri)
public void	setId(String id)
public void	setName(String name)
public void	setPolicies(List<PolicyRepresentation> policies)
public void	setResources(List<ResourceRepresentation> resources)

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

displayName	back to summary
private String displayName

iconUri	back to summary
private String iconUri

id	back to summary
private String id

name	back to summary
private String name

policies	back to summary
private List<PolicyRepresentation> policies

resources	back to summary
private List<ResourceRepresentation> resources

ScopeRepresentation	back to summary
public ScopeRepresentation(String name, String iconUri) Creates an instance. Parameters name:String the a human-readable string describing some scope (extent) of access iconUri:String a `URI` for a graphic icon representing the scope

ScopeRepresentation	back to summary
public ScopeRepresentation(String name) Creates an instance. Parameters name:String the a human-readable string describing some scope (extent) of access

ScopeRepresentation	back to summary
public ScopeRepresentation() Creates an instance.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getDisplayName	back to summary
public String getDisplayName()

getIconUri	back to summary
public String getIconUri()

getId	back to summary
public String getId()

getName	back to summary
public String getName()

getPolicies	back to summary
public List<PolicyRepresentation> getPolicies()

getResources	back to summary
public List<ResourceRepresentation> getResources()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object.

setDisplayName	back to summary
public void setDisplayName(String displayName)

setIconUri	back to summary
public void setIconUri(String iconUri)

setId	back to summary
public void setId(String id)

setName	back to summary
public void setName(String name)

setPolicies	back to summary
public void setPolicies(List<PolicyRepresentation> policies)

setResources	back to summary
public void setResources(List<ResourceRepresentation> resources)

public Class ScopeRepresentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail