Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class ResourceBase

extends Object
implements Serializable, Injectable
Class Inheritance
All Implemented Interfaces
org.apache.tomcat.util.descriptor.web.Injectable, java.io.Serializable
Known Direct Subclasses
org.apache.tomcat.util.descriptor.web.ContextEjb, org.apache.tomcat.util.descriptor.web.ContextEnvironment, org.apache.tomcat.util.descriptor.web.ContextHandler, org.apache.tomcat.util.descriptor.web.ContextLocalEjb, org.apache.tomcat.util.descriptor.web.ContextResource, org.apache.tomcat.util.descriptor.web.ContextResourceEnvRef, org.apache.tomcat.util.descriptor.web.ContextResourceLink, org.apache.tomcat.util.descriptor.web.ContextService, org.apache.tomcat.util.descriptor.web.MessageDestination, org.apache.tomcat.util.descriptor.web.MessageDestinationRef
Imports
java.io.Serializable, java.util.ArrayList, .HashMap, .Iterator, .List, .Map

Representation of an Context element
Author
Peter Rossbach ([email protected])

Field Summary

Modifier and TypeField and Description
private String
description

The description of this resource.

private final List<InjectionTarget>
private String
private String
name

The name of this resource.

private final Map<String, Object>
properties

Holder for our configured properties.

private NamingResources
resources

The NamingResources with which we are associated (if any).

private static final long
private String
type

The name of the resource implementation class.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

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

public String
public List<InjectionTarget>
public String
public String
public NamingResources
public Object

Returns:

a configured property.
getProperty
(String
The property name
name
)

public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Iterator<String>

Returns:

the property names iterator
listProperties
()

List properties.

public void
removeProperty(String
The property name
name
)

Remove a configured property.

public void
setDescription(String description)

public void
setLookupName(String lookupName)

public void
public void
public void
setProperty(String
The property name
name
,
Object
The property value
value
)

Set a configured property.

public void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

descriptionback to summary
private String description

The description of this resource.

injectionTargetsback to summary
private final List<InjectionTarget> injectionTargets
lookupNameback to summary
private String lookupName
nameback to summary
private String name

The name of this resource.

propertiesback to summary
private final Map<String, Object> properties

Holder for our configured properties.

resourcesback to summary
private NamingResources resources

The NamingResources with which we are associated (if any).

serialVersionUIDback to summary
private static final long serialVersionUID
typeback to summary
private String type

The name of the resource implementation class.

Constructor Detail

ResourceBaseback to summary
public ResourceBase()

Method Detail

addInjectionTargetback to summary
public void addInjectionTarget(String injectionTargetName, String jndiName)

Implements org.apache.tomcat.util.descriptor.web.Injectable.addInjectionTarget.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

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
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
getDescriptionback to summary
public String getDescription()
getInjectionTargetsback to summary
public List<InjectionTarget> getInjectionTargets()

Implements org.apache.tomcat.util.descriptor.web.Injectable.getInjectionTargets.

Annotations
@Override
getLookupNameback to summary
public String getLookupName()
getNameback to summary
public String getName()

Implements org.apache.tomcat.util.descriptor.web.Injectable.getName.

Annotations
@Override
getNamingResourcesback to summary
public NamingResources getNamingResources()
getPropertyback to summary
public Object getProperty(String name)
Parameters
name:String

The property name

Returns:Object

a configured property.

getTypeback to summary
public String getType()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.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
listPropertiesback to summary
public Iterator<String> listProperties()

List properties.

Returns:Iterator<String>

the property names iterator

removePropertyback to summary
public void removeProperty(String name)

Remove a configured property.

Parameters
name:String

The property name

setDescriptionback to summary
public void setDescription(String description)
setLookupNameback to summary
public void setLookupName(String lookupName)
setNameback to summary
public void setName(String name)
setNamingResourcesback to summary
public void setNamingResources(NamingResources resources)
setPropertyback to summary
public void setProperty(String name, Object value)

Set a configured property.

Parameters
name:String

The property name

value:Object

The property value

setTypeback to summary
public void setType(String type)