net.sf.ant4eclipse.model.project.cproject
Class CPathEntry

java.lang.Object
  net.sf.ant4eclipse.model.project.cproject.CPathEntry

public class CPathEntry
extends java.lang.Object

A path entry as it's been used within C/C++ projects.

Field Summary

static int	CPE_CONTAINER a container path which requires some resolving
static int	CPE_INCLUDE an include path
static int	CPE_MACRO a macro value
static int	CPE_OUTPUT an output path
static int	CPE_SOURCE a source path

Constructor Summary

CPathEntry(int kind, java.lang.String path)
Initializes this path entry with a specific type and a corresponding value.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getBasePath() Returns the location of an additional path associated with this entry.
java.lang.String	getInclude() Returns the current include location of this C/C++ path.
int	getKind() Returns the kind of path entry.
java.lang.String	getName() Returns the name of the macro entry.
java.lang.String	getPath() Returns the path value for this entry.
java.lang.String	getValue() Returns the value of the macro entry.
int	hashCode()
boolean	isSystemEntry() Returns true if this path entry is related to the system.
void	setBasePath(java.lang.String basepath) Changes the base path which is used in conjunction with system entries to locate an additional path.
void	setInclude(java.lang.String include) Changes the include location of this C/C++ path.
void	setName(java.lang.String name) Sets the name for a macro entry.
void	setSystemEntry(boolean system) (Un)Marks this entry as a system specific one.
void	setValue(java.lang.String value) Sets the value for a macro entry.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CPE_CONTAINER

public static final int CPE_CONTAINER

a container path which requires some resolving

See Also:

Constant Field Values

CPE_SOURCE

public static final int CPE_SOURCE

a source path

See Also:

Constant Field Values

CPE_INCLUDE

public static final int CPE_INCLUDE

an include path

See Also:

Constant Field Values

CPE_OUTPUT

public static final int CPE_OUTPUT

an output path

See Also:

Constant Field Values

CPE_MACRO

public static final int CPE_MACRO

a macro value

See Also:

Constant Field Values

Constructor Detail

CPathEntry

public CPathEntry(int kind,
                  java.lang.String path)

Initializes this path entry with a specific type and a corresponding value.

Parameters:

kind - A CPE_??? constant which declares the kind of this entry.

path - A value depending on the kind.

Method Detail

getKind

public int getKind()

Returns the kind of path entry.

Returns:

The kind of path entry.

getPath

public java.lang.String getPath()

Returns the path value for this entry.

Returns:

The path value for this entry.

setInclude

public void setInclude(java.lang.String include)

Changes the include location of this C/C++ path.

Parameters:

include - The new include location of the C/C++ path.

getInclude

public java.lang.String getInclude()

Returns the current include location of this C/C++ path.

Returns:

The current include location of this C/C++ path.

setSystemEntry

public void setSystemEntry(boolean system)

(Un)Marks this entry as a system specific one.

Parameters:

system - true <=> This path entry is related to the system.

isSystemEntry

public boolean isSystemEntry()

Returns true if this path entry is related to the system.

Returns:

true <=> This path entry is related to the system.

setBasePath

public void setBasePath(java.lang.String basepath)

Changes the base path which is used in conjunction with system entries to locate an additional path.

Parameters:

basepath - An additional path that is associated with this entry.

getBasePath

public java.lang.String getBasePath()

Returns the location of an additional path associated with this entry.

Returns:

The location of an additional path associated with this entry.

setName

public void setName(java.lang.String name)

Sets the name for a macro entry.

Parameters:

name - The name of the macro entry.

getName

public java.lang.String getName()

Returns the name of the macro entry.

Returns:

The name of the macro entry.

setValue

public void setValue(java.lang.String value)

Sets the value for a macro entry.

Parameters:

value - The value for the macro entry.

getValue

public java.lang.String getValue()

Returns the value of the macro entry.

Returns:

The value of the macro entry.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object