blob: 9054003508e0ec311f53fd07ff62e748b464b27d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
/*******************************************************************************
* Copyright (c) 2011, 2012 Wind River Systems, Inc. and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.runtime.services.interfaces;
import java.util.Map;
/**
* Properties access service.
* <p>
* Allows generic access to properties of a given context without having to know all the details and
* limitations for accessing the desired properties.
*/
public interface IPropertiesAccessService extends IService {
/**
* Returns a unmodifiable map containing the target addresses and ports for the given context,
* if it can be determined.
* <p>
* A context may return multiple target addresses and ports if the context can be reached using
* different connection methods.
* <p>
* <b>Note:</b>
* <ul>
* <li>See the constants defined in the properties access constants interface for default
* address and port types.</li>
* <li>The target address returned must <b>not</b> necessarily be an IP address.</li>
* <li>The values of the address or port properties might be <code>null</code>.</li>
* </ul>
*
* @param context The context to get the target addresses and ports from. Must not be <code>null</code>.
* @return The unmodifiable map containing the target addresses and ports, or <code>null</code>.
*/
public Map<String, String> getTargetAddress(Object context);
/**
* Returns the property value stored under the given property key. If the property does not
* exist, <code>null</code> is returned.
*
* @param context The context to get the property from. Must not be <code>null</code>.
* @param key The property key. Must not be <code>null</code>.
*
* @return The stored property value or <code>null</code>.
*/
public Object getProperty(Object context, String key);
/**
* Set the property with the key with the given value.
*
* @param context The context to set the property to. Must not be <code>null</code>.
* @param key The property key. Must not be <code>null</code>.
* @param value The value to set.
* @return <code>true</code> if the value was set.
*/
public boolean setProperty(Object context, String key, Object value);
/**
* Returns the direct parent node of the given context object.
*
* @param context The context to get the parent from. Must not be <code>null</code>.
* @return The direct parent node or <code>null</code>.
*/
public Object getParent(Object context);
}
|