hudson.tools
Class ToolInstallation

java.lang.Object
  extended by hudson.model.AbstractDescribableImpl<ToolInstallation>
      extended by hudson.tools.ToolInstallation
All Implemented Interfaces:
ExtensionPoint, Describable<ToolInstallation>, Serializable
Direct Known Subclasses:
Ant.AntInstallation, JDK, Maven.MavenInstallation

public abstract class ToolInstallation
extends AbstractDescribableImpl<ToolInstallation>
implements Serializable, ExtensionPoint

Formalization of a tool installed in nodes used for builds (examples include things like JDKs, Ants, Mavens, etc..)

You can define such a concept in your plugin entirely on your own, without extending from this class, but choosing this class as a base class has several benefits:

Implementations of this class are strongly encouraged to also implement NodeSpecific (by using translateFor(Node, TaskListener)) and EnvironmentSpecific (by using EnvVars.expand(String).)

To contribute an extension point, put Extension on your ToolDescriptor class.

Since:
1.286
Author:
huybrechts
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
 
Constructor Summary
ToolInstallation(String name, String home)
          Deprecated. as of 1.302. Use ToolInstallation(String, String, List)
ToolInstallation(String name, String home, List<? extends ToolProperty<?>> properties)
           
 
Method Summary
static DescriptorExtensionList<ToolInstallation,ToolDescriptor<?>> all()
          Returns all the registered ToolDescriptors.
 String getHome()
          Gets the home directory of this tool.
 String getName()
          Gets the human readable name that identifies this tool among other ToolInstallations of the same kind.
 DescribableList<ToolProperty<?>,ToolPropertyDescriptor> getProperties()
           
 
Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ToolInstallation

public ToolInstallation(String name,
                        String home)
Deprecated. as of 1.302. Use ToolInstallation(String, String, List)


ToolInstallation

public ToolInstallation(String name,
                        String home,
                        List<? extends ToolProperty<?>> properties)
Method Detail

getName

public String getName()
Gets the human readable name that identifies this tool among other ToolInstallations of the same kind.


getHome

public String getHome()
Gets the home directory of this tool. The path can be in Unix format as well as in Windows format. Must be absolute.


getProperties

public DescribableList<ToolProperty<?>,ToolPropertyDescriptor> getProperties()

all

public static DescriptorExtensionList<ToolInstallation,ToolDescriptor<?>> all()
Returns all the registered ToolDescriptors.



Copyright © 2004-2013 Hudson. All Rights Reserved.