Top Description Inners Methods
org.freedesktop.dbus.annotations

public @Interface PropertiesEmitsChangedSignal

extends Annotation
Annotations
@Target:METHOD
@Retention:RUNTIME
@DBusInterfaceName:org.freedesktop.DBus.Property.EmitsChangedSignal
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target
From DBUS Specification:
If set to false, the org.freedesktop.DBus.Properties.PropertiesChanged signal,
see the section called “org.freedesktop.DBus.Properties” is not guaranteed to be emitted if the property changes.

If set to const the property never changes value during the lifetime of the object it belongs to,
and hence the signal is never emitted for it.

If set to invalidates the signal is emitted but the value is not included in the signal.

If set to true the signal is emitted with the value included.
The value for the annotation defaults to true if the enclosing interface element does not specify the annotation. Otherwise it defaults to the value specified in the enclosing interface element.

This annotation is intended to be used by code generators to implement client-side caching of property values.
For all properties for which the annotation is set to const, invalidates or true the client may unconditionally
cache the values as the properties don't change or notifications are generated for them if they do.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
PropertiesEmitsChangedSignal.EmitChangeSignal

The different values which are supported for emitting a signal.

Method Summary

Modifier and TypeMethod and Description
public PropertiesEmitsChangedSignal.EmitChangeSignal
value()

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public PropertiesEmitsChangedSignal.EmitChangeSignal value()
org.freedesktop.dbus.annotations back to summary

public final Enum PropertiesEmitsChangedSignal.EmitChangeSignal

extends Enum<PropertiesEmitsChangedSignal.EmitChangeSignal>
Class Inheritance
The different values which are supported for emitting a signal.

Field Summary

Modifier and TypeField and Description
public static final PropertiesEmitsChangedSignal.EmitChangeSignal
CONST

The property never changes value during the lifetime of the object it belongs to, and hence the signal is never emitted for it.

public static final PropertiesEmitsChangedSignal.EmitChangeSignal
FALSE

It is not guaranteed to emit a signal if the property changes.

public static final PropertiesEmitsChangedSignal.EmitChangeSignal
INVALIDATES

The signal is emitted but the value is not included in the signal.

public static final PropertiesEmitsChangedSignal.EmitChangeSignal
TRUE

The signal is emitted with the value included.

Constructor Summary

AccessConstructor and Description
private
EmitChangeSignal()

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static PropertiesEmitsChangedSignal.EmitChangeSignal
valueOf(String name)

public static PropertiesEmitsChangedSignal.EmitChangeSignal[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

CONSTback to summary
public static final PropertiesEmitsChangedSignal.EmitChangeSignal CONST

The property never changes value during the lifetime of the object it belongs to, and hence the signal is never emitted for it.

FALSEback to summary
public static final PropertiesEmitsChangedSignal.EmitChangeSignal FALSE

It is not guaranteed to emit a signal if the property changes.

INVALIDATESback to summary
public static final PropertiesEmitsChangedSignal.EmitChangeSignal INVALIDATES

The signal is emitted but the value is not included in the signal.

TRUEback to summary
public static final PropertiesEmitsChangedSignal.EmitChangeSignal TRUE

The signal is emitted with the value included.

Constructor Detail

EmitChangeSignalback to summary
private EmitChangeSignal()

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static PropertiesEmitsChangedSignal.EmitChangeSignal valueOf(String name)
valuesback to summary
public static PropertiesEmitsChangedSignal.EmitChangeSignal[] values()