org.opensolaris.opengrok.configuration
Class Project

java.lang.Object
  extended by org.opensolaris.opengrok.configuration.Project

public class Project
extends java.lang.Object

Placeholder for the information that builds up a project


Constructor Summary
Project()
           
 
Method Summary
 java.lang.String getDescription()
          Get a textual description of this project
 java.lang.String getId()
          Get the project id
 java.lang.String getPath()
          Get the path (relative from source root) where this project is located
static Project getProject(java.io.File file)
          Get the project for a specific file
static Project getProject(java.lang.String path)
          Get the project for a specific file
 void setDescription(java.lang.String description)
          Set a textual description of this project
 void setPath(java.lang.String path)
          Set the path (relative from source root) this project is located
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Project

public Project()
Method Detail

getDescription

public java.lang.String getDescription()
Get a textual description of this project

Returns:
a textual description of the project

getPath

public java.lang.String getPath()
Get the path (relative from source root) where this project is located

Returns:
the relative path

getId

public java.lang.String getId()
Get the project id

Returns:
the id of the project

setDescription

public void setDescription(java.lang.String description)
Set a textual description of this project

Parameters:
description - a textual description of the project

setPath

public void setPath(java.lang.String path)
Set the path (relative from source root) this project is located

Parameters:
path - the relative path from source sroot where this project is located.

getProject

public static Project getProject(java.lang.String path)
Get the project for a specific file

Parameters:
path - the file to lookup (relative from source root)
Returns:
the project that this file belongs to (or null if the file doesn't belong to a project)

getProject

public static Project getProject(java.io.File file)
Get the project for a specific file

Parameters:
file - the file to lookup
Returns:
the project that this file belongs to (or null if the file doesn't belong to a project)