Extension SDK 9.0.5

oracle.jdeveloper.vcs.spi
Class VCSPropertyMap

java.lang.Object
  extended byoracle.ide.config.ChangeEventSource
      extended byoracle.jdeveloper.vcs.spi.VCSPropertyMap
All Implemented Interfaces:
Copyable

public class VCSPropertyMap
extends ChangeEventSource
implements Copyable

Class for storing a version control client property map.

Since:
9.0.5

Constructor Summary
VCSPropertyMap()
           
VCSPropertyMap(java.util.Map map)
           
 
Method Summary
 java.lang.Object copyTo(java.lang.Object target)
          Copies the internal state of this object to the specified copy.
 java.util.Map getMap()
          Gets the version control client property map.
 void setMap(java.util.Map map)
          Sets the version control client property map.
 
Methods inherited from class oracle.ide.config.ChangeEventSource
addChangeListener, fireChangeEvent, fireChangeEvent, removeChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VCSPropertyMap

public VCSPropertyMap()

VCSPropertyMap

public VCSPropertyMap(java.util.Map map)
Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)
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:
target - 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.

setMap

public void setMap(java.util.Map map)
Sets the version control client property map.

Parameters:
map - the property map.

getMap

public java.util.Map getMap()
Gets the version control client property map.

Returns:
the property map.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.