Package org.robolectric.shadows

Class ShadowVibrator

java.lang.Object

org.robolectric.shadows.ShadowVibrator

Direct Known Subclasses:

ShadowSystemVibrator

@Implements(android.os.Vibrator.class)
public class ShadowVibrator
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected long[]	pattern
protected List<Integer>	supportedPrimitives
protected VibrationAttributes	vibrationAttributesFromLastVibration
protected List<VibrationEffectSegment>	vibrationEffectSegments

Constructor Summary

Constructors

Constructor	Description
ShadowVibrator()

Method Summary

Modifier and Type	Method	Description
protected boolean	areAllPrimitivesSupported(int... primitiveIds)
int	getEffectId()	Returns the last vibration effect ID of a VibrationEffect#Prebaked (e.g.
long	getMilliseconds()	Returns the last vibration duration in MS.
long[]	getPattern()	Returns the last vibration pattern.
int	getRepeat()	Returns the last vibration repeat times.
VibrationAttributes	getVibrationAttributesFromLastVibration()	Returns the VibrationAttributes from the last vibration.
List<VibrationEffectSegment>	getVibrationEffectSegments()	Returns the last list of VibrationEffectSegment.
boolean	isCancelled()	Returns true if the Vibrator has been cancelled.
boolean	isVibrating()	Returns true if the Vibrator is currently vibrating as controlled by Vibrator.vibrate(long)
void	setHasAmplitudeControl(boolean hasAmplitudeControl)	Controls the return value of Vibrator.hasAmplitudeControl() the default is false.
void	setHasVibrator(boolean hasVibrator)	Controls the return value of Vibrator.hasVibrator() the default is true.
void	setSupportedPrimitives(Collection<Integer> primitives)	Adds supported vibration primitives.

Methods inherited from class java.lang.Object

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

Field Detail

pattern

protected long[] pattern

vibrationEffectSegments

protected final List<VibrationEffectSegment> vibrationEffectSegments

supportedPrimitives

protected final List<Integer> supportedPrimitives

vibrationAttributesFromLastVibration

@Nullable
protected VibrationAttributes vibrationAttributesFromLastVibration

Constructor Detail

ShadowVibrator

public ShadowVibrator()

Method Detail

setHasVibrator

public void setHasVibrator(boolean hasVibrator)

Controls the return value of Vibrator.hasVibrator() the default is true.

setHasAmplitudeControl

public void setHasAmplitudeControl(boolean hasAmplitudeControl)

Controls the return value of Vibrator.hasAmplitudeControl() the default is false.

isVibrating

@Implementation(minSdk=30)
public boolean isVibrating()

Returns true if the Vibrator is currently vibrating as controlled by Vibrator.vibrate(long)

isCancelled

public boolean isCancelled()

Returns true if the Vibrator has been cancelled.

getMilliseconds

public long getMilliseconds()

Returns the last vibration duration in MS.

getPattern

public long[] getPattern()

Returns the last vibration pattern.

getEffectId

public int getEffectId()

Returns the last vibration effect ID of a VibrationEffect#Prebaked (e.g. VibrationEffect.EFFECT_CLICK).

This field is non-zero only if a VibrationEffect#Prebaked was ever requested.

getRepeat

public int getRepeat()

Returns the last vibration repeat times.

getVibrationEffectSegments

public List<VibrationEffectSegment> getVibrationEffectSegments()

Returns the last list of VibrationEffectSegment.

areAllPrimitivesSupported

@Implementation(minSdk=30)
protected boolean areAllPrimitivesSupported(int... primitiveIds)

setSupportedPrimitives

public void setSupportedPrimitives(Collection<Integer> primitives)

Adds supported vibration primitives.

getVibrationAttributesFromLastVibration

@Nullable
public VibrationAttributes getVibrationAttributesFromLastVibration()

Returns the VibrationAttributes from the last vibration.