org.jboss.ejb.client

Class EntityEJBLocator<T extends EJBObject>

java.lang.Object

org.jboss.ejb.client.EJBLocator<T>

org.jboss.ejb.client.EntityEJBLocator<T>

Type Parameters:

T - the remote view type

All Implemented Interfaces:

Serializable

public final class EntityEJBLocator<T extends EJBObject>
extends EJBLocator<T>

A locator for an entity EJB.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntityEJBLocator(Class<T> viewType, EJBIdentifier identifier, Object primaryKey) Construct a new instance.
EntityEJBLocator(Class<T> viewType, EJBIdentifier identifier, Object primaryKey, Affinity affinity) Construct a new instance.
EntityEJBLocator(Class<T> viewType, String appName, String moduleName, String beanName, Object primaryKey) Construct a new instance.
EntityEJBLocator(Class<T> viewType, String appName, String moduleName, String beanName, Object primaryKey, Affinity affinity) Construct a new instance.
EntityEJBLocator(Class<T> viewType, String appName, String moduleName, String beanName, String distinctName, Object primaryKey) Construct a new instance.
EntityEJBLocator(Class<T> viewType, String appName, String moduleName, String beanName, String distinctName, Object primaryKey, Affinity affinity) Construct a new instance.
EntityEJBLocator(EntityEJBLocator<T> original, Affinity newAffinity) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static <T extends EJBObject> EntityEJBLocator<T>	create(Class<T> viewType, EJBIdentifier identifier, Object primaryKey, Affinity affinity) Construct a new instance.
boolean	equals(EJBLocator<?> other) Determine whether this object is equal to another.
boolean	equals(EntityEJBLocator<?> other) Determine whether this object is equal to another.
boolean	equals(Object other) Determine whether this object is equal to another.
Object	getPrimaryKey() Get the primary key for the referenced entity.
boolean	isEntity() Determine if this is an entity locator.
<S extends EJBObject> EntityEJBLocator<? extends S>	narrowAsEntity(Class<S> type) Narrow this locator to the target type as a entity locator.
<S> EntityEJBLocator<? extends S>	narrowTo(Class<S> type) Narrow this locator to the target type.
String	toString()
EntityEJBLocator<T>	withNewAffinity(Affinity affinity) Create a copy of this locator, but with the new given affinity.

Methods inherited from class org.jboss.ejb.client.EJBLocator

asStateful, asStateless, canNarrowTo, createProxyInstance, getAffinity, getAppName, getBeanName, getDistinctName, getIdentifier, getModuleName, getProxyClass, getProxyConstructor, getViewType, hashCode, isHome, isStateful, isStateless, narrowAsHome, narrowAsStateful, narrowAsStateless, withSession, withSessionAndAffinity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        String appName,
                        String moduleName,
                        String beanName,
                        Object primaryKey)

Construct a new instance.

Parameters:

viewType - the view type

appName - the application name

moduleName - the module name

beanName - the bean name

primaryKey - the entity primary key

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        String appName,
                        String moduleName,
                        String beanName,
                        Object primaryKey,
                        Affinity affinity)

Construct a new instance.

Parameters:

viewType - the view type

appName - the application name

moduleName - the module name

beanName - the bean name

primaryKey - the entity primary key

affinity - the affinity

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        String appName,
                        String moduleName,
                        String beanName,
                        String distinctName,
                        Object primaryKey)

Construct a new instance.

Parameters:

viewType - the view type

appName - the application name

moduleName - the module name

beanName - the bean name

distinctName - the distinct name

primaryKey - the entity primary key

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        String appName,
                        String moduleName,
                        String beanName,
                        String distinctName,
                        Object primaryKey,
                        Affinity affinity)

Construct a new instance.

Parameters:

viewType - the view type

appName - the application name

moduleName - the module name

beanName - the bean name

distinctName - the distinct name

primaryKey - the entity primary key

affinity - the affinity

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        EJBIdentifier identifier,
                        Object primaryKey,
                        Affinity affinity)

Construct a new instance.

Parameters:

viewType - the view type

identifier - the EJB identifier

primaryKey - the entity primary key

affinity - the affinity

EntityEJBLocator

public EntityEJBLocator(Class<T> viewType,
                        EJBIdentifier identifier,
                        Object primaryKey)

Construct a new instance.

Parameters:

viewType - the view type

identifier - the EJB identifier

primaryKey - the entity primary key

EntityEJBLocator

public EntityEJBLocator(EntityEJBLocator<T> original,
                        Affinity newAffinity)

Construct a new instance. This constructor creates a copy of the original locator, but with a new affinity.

Parameters:

original - the original locator

newAffinity - the new affinity

Method Detail

create

public static <T extends EJBObject> EntityEJBLocator<T> create(Class<T> viewType,
                                                               EJBIdentifier identifier,
                                                               Object primaryKey,
                                                               Affinity affinity)

Construct a new instance.

Type Parameters:

T - the remote view type

Parameters:

viewType - the view type (must not be null)

identifier - the EJB identifier (must not be null)

primaryKey - the entity primary key (must not be null)

affinity - the affinity

Returns:

the new instance (not null)

withNewAffinity

public EntityEJBLocator<T> withNewAffinity(Affinity affinity)

Description copied from class: EJBLocator

Create a copy of this locator, but with the new given affinity.

Specified by:

withNewAffinity in class EJBLocator<T extends EJBObject>

Parameters:

affinity - the new affinity

Returns:

the new locator

narrowTo

public <S> EntityEJBLocator<? extends S> narrowTo(Class<S> type)

Description copied from class: EJBLocator

Narrow this locator to the target type.

Overrides:

narrowTo in class EJBLocator<T extends EJBObject>

Type Parameters:

S - the target type

Parameters:

type - the target type class

Returns:

this instance, narrowed to the given type

narrowAsEntity

public <S extends EJBObject> EntityEJBLocator<? extends S> narrowAsEntity(Class<S> type)

Description copied from class: EJBLocator

Narrow this locator to the target type as a entity locator.

Overrides:

narrowAsEntity in class EJBLocator<T extends EJBObject>

Type Parameters:

S - the target type

Parameters:

type - the target type class

Returns:

this instance, narrowed to the given type and cast as a entity locator

isEntity

public boolean isEntity()

Description copied from class: EJBLocator

Determine if this is an entity locator. If so, calls to EJBLocator.narrowAsEntity(Class) will generally succeed.

Overrides:

isEntity in class EJBLocator<T extends EJBObject>

Returns:

true if this locator is an entity, false otherwise

getPrimaryKey

public Object getPrimaryKey()

Get the primary key for the referenced entity.

Returns:

the primary key for the referenced entity

equals

public boolean equals(Object other)

Determine whether this object is equal to another.

Overrides:

equals in class EJBLocator<T extends EJBObject>

Parameters:

other - the other object

Returns:

true if they are equal, false otherwise

equals

public boolean equals(EJBLocator<?> other)

Determine whether this object is equal to another.

Overrides:

equals in class EJBLocator<T extends EJBObject>

Parameters:

other - the other object

Returns:

true if they are equal, false otherwise

equals

public boolean equals(EntityEJBLocator<?> other)

Determine whether this object is equal to another.

Parameters:

other - the other object

Returns:

true if they are equal, false otherwise

toString

public String toString()

Overrides:

toString in class EJBLocator<T extends EJBObject>