Tomcat 10.1.19 · org.apache.tomcat.util.descriptor.web.ContextResource

Modifier and Type	Field and Description
private String	auth The authorization requirement for this resource (`Application` or `Container`).
private String	closeMethod The name of the zero argument method to be called when the resource is no longer required to clean-up resources.
private boolean	closeMethodConfigured
private String	scope The sharing scope of this resource factory (`Shareable` or `Unshareable`).
private static final long	serialVersionUID Hides org.apache.tomcat.util.descriptor.web.ResourceBase.serialVersionUID.
private boolean	singleton Is this resource known to be a singleton resource.

Access	Constructor and Description
public	ContextResource()

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.equals. Indicates whether some other object is "equal to" this one.
public String	getAuth()
public String	getCloseMethod()
public boolean	getCloseMethodConfigured()
public String	getScope()
public boolean	getSingleton()
public int	hashCode() Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode. Returns a hash code value for this object.
public void	setAuth(String auth)
public void	setCloseMethod(String closeMethod)
public void	setScope(String scope)
public void	setSingleton(boolean singleton)
public String	toString() Overrides java.lang.Object.toString. Return a String representation of this object.

Field Detail

auth	back to summary
private String auth The authorization requirement for this resource (`Application` or `Container`).

closeMethod	back to summary
private String closeMethod The name of the zero argument method to be called when the resource is no longer required to clean-up resources. This method must only speed up the clean-up of resources that would otherwise happen via garbage collection.

closeMethodConfigured	back to summary
private boolean closeMethodConfigured

scope	back to summary
private String scope The sharing scope of this resource factory (`Shareable` or `Unshareable`).

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.tomcat.util.descriptor.web.ResourceBase.serialVersionUID.

singleton	back to summary
private boolean singleton Is this resource known to be a singleton resource. The default value is true since this is what users expect although the Jakarta EE spec implies that the default should be false.

ContextResource	back to summary
public ContextResource()

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.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 obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.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

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

Returns:boolean

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

Annotations

@Override

getAuth	back to summary
public String getAuth()

getCloseMethod	back to summary
public String getCloseMethod()

getCloseMethodConfigured	back to summary
public boolean getCloseMethodConfigured()

getScope	back to summary
public String getScope()

getSingleton	back to summary
public boolean getSingleton()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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 Annotations @Override

public int hashCode()

Overrides org.apache.tomcat.util.descriptor.web.ResourceBase.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

Annotations

@Override

setAuth	back to summary
public void setAuth(String auth)

setCloseMethod	back to summary
public void setCloseMethod(String closeMethod)

setScope	back to summary
public void setScope(String scope)

setSingleton	back to summary
public void setSingleton(boolean singleton)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a String representation of this object. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class ContextResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail