Top Description Fields Constructors Methods
org.osgi.service.wireadmin

public Class BasicEnvelope

extends Object
implements Envelope
Class Inheritance
All Implemented Interfaces
org.osgi.service.wireadmin.Envelope
BasicEnvelope is an implementation of the Envelope interface
Author
$Id: b9b13e2e6a7da87146d73fcd4dc3b4ec5f5cc4a9 $

Field Summary

Modifier and TypeField and Description
private final Object
identification

private final String
scope

private final Object
value

Constructor Summary

AccessConstructor and Description
public
BasicEnvelope(Object
Content of this envelope, may be null.
value, Object
Identifying object for this Envelope object, must not be null
identification, String
Scope name for this object, must not be null
scope)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public Object
getIdentification()

Implements org.osgi.service.wireadmin.Envelope.getIdentification.

Return the identification of this Envelope object.

public String
getScope()

Implements org.osgi.service.wireadmin.Envelope.getScope.

Return the scope name of this Envelope object.

public Object
getValue()

Implements org.osgi.service.wireadmin.Envelope.getValue.

Return the value associated with this Envelope object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

identificationback to summary
private final Object identification
scopeback to summary
private final String scope
valueback to summary
private final Object value

Constructor Detail

BasicEnvelopeback to summary
public BasicEnvelope(Object value, Object identification, String scope)

Constructor.

Parameters
value:Object

Content of this envelope, may be null.

identification:Object

Identifying object for this Envelope object, must not be null

scope:String

Scope name for this object, must not be null

See Also
Envelope

Method Detail

getIdentificationback to summary
public Object getIdentification()

Implements org.osgi.service.wireadmin.Envelope.getIdentification.

Doc from org.osgi.service.wireadmin.Envelope.getIdentification.

Return the identification of this Envelope object. An identification may be of any Java type. The type must be mutually agreed between the Consumer and Producer services.

Returns:Object

an object which identifies the status item in the address space of the composite producer, must not be null.

Annotations
@Override
See Also
org.osgi.service.wireadmin.Envelope#getIdentification()
getScopeback to summary
public String getScope()

Implements org.osgi.service.wireadmin.Envelope.getScope.

Doc from org.osgi.service.wireadmin.Envelope.getScope.

Return the scope name of this Envelope object. Scope names are used to restrict the communication between the Producer and Consumer services. Only Envelopes objects with a scope name that is permitted for the Producer and the Consumer services must be passed through a Wire object.

Returns:String

the security scope for the status item, must not be null.

Annotations
@Override
See Also
org.osgi.service.wireadmin.Envelope#getScope()
getValueback to summary
public Object getValue()

Implements org.osgi.service.wireadmin.Envelope.getValue.

Doc from org.osgi.service.wireadmin.Envelope.getValue.

Return the value associated with this Envelope object.

Returns:Object

the value of the status item, or null when no item is associated with this object.

Annotations
@Override
See Also
org.osgi.service.wireadmin.Envelope#getValue()