oracle.ide.model
Class TechnologyScope

java.lang.Object
  oracle.ide.model.TechnologyScope

All Implemented Interfaces:

Copyable

public final class TechnologyScope
extends java.lang.Object
implements Copyable

The TechnologyScope class is used to group a set of technologies. The group of technologies comprise the scope of associated object (for example, a project).

Constructor Summary

TechnologyScope()
Constructs an empty TechnologyScope.

TechnologyScope(TechnologyScope scope)
Copy contructor.

Method Summary

boolean	add(TechId techId) Ensures that a technology exists in the technology scope.
void	clear() Removes all technologies from this technology scope.
boolean	contains(TechId techId) Tests whether a technology exists in the technology scope.
boolean	contains(TechnologyScope scope) Tests whether another TechnologyScope is a sub-set of this scope.
java.lang.Object	copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(TechnologyScope scope)
boolean	equals(java.lang.Object object)
protected boolean	equalsImpl(TechnologyScope scope)
java.lang.String[]	getTechnologyKeys() Used for persistence of the TechnologyScope via Object2Dom.
boolean	isEmpty() Returns true if there are no technologies in this scope, otherwise returns false.
boolean	remove(TechId techId) Ensures that a technology does not exist in the technology scope.
void	setTechnologyKeys(java.lang.String[] keys) Used for persistence of the TechnologyScope via Object2Dom.
TechId[]	toArray() Returns an array of all technology identifiers in this scope.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TechnologyScope

public TechnologyScope()

Constructs an empty TechnologyScope.

TechnologyScope

public TechnologyScope(TechnologyScope scope)

Copy contructor.

Method Detail

add

public boolean add(TechId techId)

Ensures that a technology exists in the technology scope.

Parameters:

techId - the identifier for the technology to be added.

Returns:

true if the technology scope changed as a result of the call; otherwise, returns false (e.g., the technology was already set in this scope).

remove

public boolean remove(TechId techId)

Ensures that a technology does not exist in the technology scope.

Parameters:

techId - the identifier for the technology to be removed.

Returns:

true if the technology scope changed as a result of the call; otherwise, returns false (e.g., the technology was not set in this scope).

clear

public void clear()

Removes all technologies from this technology scope.

contains

public boolean contains(TechId techId)

Tests whether a technology exists in the technology scope.

Parameters:

techId - the identifier for the technology to be tested.

Returns:

true if the technology exists in the technology scope; otherwise, returns false.

contains

public boolean contains(TechnologyScope scope)

Tests whether another TechnologyScope is a sub-set of this scope.

Parameters:

scope - the sub-set to test.

Returns:

true if all techIds from scope are found.

isEmpty

public boolean isEmpty()

Returns true if there are no technologies in this scope, otherwise returns false.

toArray

public TechId[] toArray()

Returns an array of all technology identifiers in this scope.

getTechnologyKeys

public java.lang.String[] getTechnologyKeys()

Used for persistence of the TechnologyScope via Object2Dom.

setTechnologyKeys

public void setTechnologyKeys(java.lang.String[] keys)

Used for persistence of the TechnologyScope via Object2Dom.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

copyTo

public java.lang.Object copyTo(java.lang.Object object)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

object - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

equalsImpl

protected final boolean equalsImpl(TechnologyScope scope)

copyToImpl

protected final void copyToImpl(TechnologyScope scope)