nl.toolforge.karma.core.location
Class BaseLocation

java.lang.Object
  nl.toolforge.karma.core.location.BaseLocation

All Implemented Interfaces:

Location

Direct Known Subclasses:

SubversionLocationImpl, VersionControlSystem

public abstract class BaseLocation

extends java.lang.Object

implements Location

BaseLocation implements some generic Location functionality.

Version:

$Id: BaseLocation.java,v 1.12 2004/11/03 20:54:15 asmedes Exp $

Author:

D.A. Smedes

Constructor Summary

BaseLocation(java.lang.String id, LocationType type)
Constructs a Location skeleton.

Method Summary

boolean	equals(java.lang.Object obj)
AuthenticatorKey	getAuthenticatorKey()
java.lang.String	getId() A locations' identifier.
LocationType	getType() The locations' type descriptor.
int	hashCode()
void	setWorkingContext(WorkingContext workingContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.toolforge.karma.core.location.Location

asXML, connect, isAvailable

Constructor Detail

BaseLocation

public BaseLocation(java.lang.String id,
                    LocationType type)

Constructs a Location skeleton.

Parameters:

id - The unique identifier for the location. Cannot be null.

type - The type of the location. Cannot be null.

Method Detail

getType

public final LocationType getType()

Description copied from interface: Location

The locations' type descriptor.

Specified by:

getType in interface Location

Returns:

A Location.Type instance.

getId

public final java.lang.String getId()

Description copied from interface: Location

A locations' identifier. Should be unique over all location-elements. This id is matched against the id-attribute of a location-element in the location-authentication.xml file (see class documentation Location.

Specified by:

getId in interface Location

Returns:

An identifier string for a location.

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

setWorkingContext

public final void setWorkingContext(WorkingContext workingContext)

Specified by:

setWorkingContext in interface Location

getAuthenticatorKey

public AuthenticatorKey getAuthenticatorKey()

Specified by:

getAuthenticatorKey in interface Location