BrowserAxis (Jenkins Sauce OnDemand plugin 1.214 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<hudson.matrix.Axis>
- - hudson.matrix.Axis
  - - hudson.plugins.sauce_ondemand.BrowserAxis

All Implemented Interfaces:

ExtensionPoint, Describable<hudson.matrix.Axis>, Comparable<hudson.matrix.Axis>, Iterable<String>

Direct Known Subclasses:

AppiumAxis, WebDriverAxis
```
public abstract class BrowserAxis
extends hudson.matrix.Axis
```
Axis that allows Sauce browsers to be selected for multi-configuration projects.

Author:

Kohsuke Kawaguchi, Ross Rowe

Nested Class Summary
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type Field Description

protected static com.saucelabs.ci.BrowserFactory BROWSER_FACTORY
Handles the retrieval of browsers from Sauce Labs.
- Fields inherited from class hudson.matrix.Axis
  name, values

Constructor Summary

Constructors
Constructor Description

BrowserAxis(List<String> values)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addBuildVariable(String value, Map<String,String> map)`	Adds the browser URI to the environment map.
`protected abstract com.saucelabs.ci.Browser`	`getBrowserForKey(String value)`
`boolean`	`hasValue(String key)`
`List<String>`	`rebuild(hudson.matrix.MatrixBuild.MatrixBuildExecution context)`

Methods inherited from class hudson.matrix.Axis
all, compareTo, equals, getDescriptor, getName, getValues, getValueString, hashCode, indexOf, isSystem, iterator, parsePrefixed, readResolve, size, toString, value

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - BROWSER_FACTORY
```
protected static final com.saucelabs.ci.BrowserFactory BROWSER_FACTORY
```
    Handles the retrieval of browsers from Sauce Labs.
- Constructor Detail
  - BrowserAxis
```
public BrowserAxis(List<String> values)
```
- Method Detail
  - hasValue
```
public boolean hasValue(String key)
```
  - rebuild
```
public List<String> rebuild(hudson.matrix.MatrixBuild.MatrixBuildExecution context)
```
    Overrides:
    
    rebuild in class hudson.matrix.Axis
  - addBuildVariable
```
public void addBuildVariable(String value,
                             Map<String,String> map)
```
    Adds the browser URI to the environment map. Will override any values set in SauceOnDemandBuildWrapper.setUp(hudson.model.AbstractBuild, hudson.Launcher, hudson.model.BuildListener)
    
    Overrides:
    
    addBuildVariable in class hudson.matrix.Axis
    
    Parameters:
    
    value - Browser key
    
    map - FIXME ??
  - getBrowserForKey
```
protected abstract com.saucelabs.ci.Browser getBrowserForKey(String value)
```
    Parameters:
    
    value - Browser Key
    
    Returns:
    
    A Browser for a given key