org.arquillian.rusheye.suite

Class Mask

java.lang.Object

org.arquillian.rusheye.suite.Properties

org.arquillian.rusheye.suite.ImageSource

org.arquillian.rusheye.suite.Mask

public class Mask
extends ImageSource

The mask for the filtering of the samples during comparison.

Required options are type, source and id.

Optional settings are alignment of the mask (for types which requires this settings).

Version:

$Revision$

Author:

Lukas Fryc

Field Summary

Fields

Modifier and Type	Field and Description
protected HorizontalAlign	horizontalAlign The horizontal align.
protected String	id The id.
protected MaskType	type The type.
protected VerticalAlign	verticalAlign The vertical align.

Fields inherited from class org.arquillian.rusheye.suite.ImageSource

source

Fields inherited from class org.arquillian.rusheye.suite.Properties

any

Constructor Summary

Constructors

Constructor and Description
Mask()

Method Summary

Modifier and Type	Method and Description
HorizontalAlign	getHorizontalAlign() Gets the horizontal alignment.
String	getId() Gets the id.
MaskType	getType() Gets the type.
VerticalAlign	getVerticalAlign() Gets the vertical alignment.
boolean	isPixelMasked(BufferedImage pattern, int x, int y) Checks if is pixel masked.
BufferedImage	retrieve() Retrieve the image from defined source.
void	setHorizontalAlign(HorizontalAlign value) Sets the horizontal alignment.
void	setId(String value) Sets the id.
void	setMaskRetriever(MaskRetriever maskRetriever) Sets the mask retriever.
void	setType(MaskType value) Sets the type.
void	setVerticalAlign(VerticalAlign value) Sets the vertical alignment.

Methods inherited from class org.arquillian.rusheye.suite.ImageSource

get, getSource, run, setSource

Methods inherited from class org.arquillian.rusheye.suite.Properties

getAny, getProperty, getProperty, getProperty, include, setProperty, size

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

The id.

type

protected MaskType type

The type.

verticalAlign

protected VerticalAlign verticalAlign

The vertical align.

horizontalAlign

protected HorizontalAlign horizontalAlign

The horizontal align.

Constructor Detail

Mask

public Mask()

Method Detail

getId

public String getId()

Gets the id.

Returns:

the id

setId

public void setId(String value)

Sets the id.

Parameters:

value - the new id

getType

public MaskType getType()

Gets the type.

Returns:

the type

setType

public void setType(MaskType value)

Sets the type.

Parameters:

value - the new type

getVerticalAlign

public VerticalAlign getVerticalAlign()

Gets the vertical alignment.

Returns:

the vertical alignment

setVerticalAlign

public void setVerticalAlign(VerticalAlign value)

Sets the vertical alignment.

Parameters:

value - the new vertical alignment

getHorizontalAlign

public HorizontalAlign getHorizontalAlign()

Gets the horizontal alignment.

Returns:

the horizontal alignment

setHorizontalAlign

public void setHorizontalAlign(HorizontalAlign value)

Sets the horizontal alignment.

Parameters:

value - the new horizontal alignment

retrieve

public BufferedImage retrieve()
                       throws Exception

Description copied from class: ImageSource

Retrieve the image from defined source.

Specified by:

retrieve in class ImageSource

Returns:

the buffered image

Throws:

Exception - the exception

isPixelMasked

public boolean isPixelMasked(BufferedImage pattern,
                             int x,
                             int y)

Checks if is pixel masked.

Parameters:

pattern - the pattern

x - the x

y - the y

Returns:

true, if is pixel masked

setMaskRetriever

public void setMaskRetriever(MaskRetriever maskRetriever)

Sets the mask retriever.

Parameters:

maskRetriever - the new mask retriever