FileDocCategorySizeDatePackage
PolicyMapMutator.javaAPI DocExample4597Tue May 29 16:56:34 BST 2007com.sun.xml.ws.policy

PolicyMapMutator

public abstract class PolicyMapMutator extends Object
The class serves as a base for specific policy map mutator implementations. It provides common methods that allow concrete mutator implementations to connect and disconnect to/from a policy map instance.
author
Marek Potociar (marek.potociar@sun.com)

Fields Summary
private static final com.sun.xml.ws.policy.privateutil.PolicyLogger
LOGGER
private PolicyMap
map
Constructors Summary
PolicyMapMutator()
Creates a new instance of PolicyMapMutator. This class cannot be extended from outside of this package.

    
                         
     
        // nothing to instantiate
    
Methods Summary
voidconnect(PolicyMap map)
The method is used to connect the policy map mutator instance to the map it should mutate.

param
map the policy map instance that will be mutable by this mutator.
throws
IllegalStateException in case this mutator object is already connected to a policy map.

        if (isConnected()) {
            throw LOGGER.logSevereException(new IllegalStateException(LocalizationMessages.WSP_0044_POLICY_MAP_MUTATOR_ALREADY_CONNECTED()));
        }
        
        this.map = map;
    
public voiddisconnect()
Disconnects the mutator from the policy map object it is connected to. Method must be called prior to connecting this mutator instance to another policy map.

This operation is irreversible: you cannot connect the mutator to the same policy map instance once you disconnect from it. Multiple consequent calls of this method will have no effect.

        this.map = null;
    
public PolicyMapgetMap()
Can be used to retrieve the policy map currently connected to this mutator. Will return {@code null} if not connected.

return
policy map currently connected to this mutator. May return {@code null} if the mutator is not connected.
see
#isConnected()
see
#disconnect()

        return this.map;
    
public booleanisConnected()
This method provides connection status information of the policy map mutator instance.

return
{@code true} if the mutator instance is connected to a policy map, otherwise returns {@code false}.

        return this.map != null;