Eclipse Plug-in Developer Guide (Galileo) - IPreferencesContainer (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.equinox.security.storage.provider
Interface IPreferencesContainer

public interface IPreferencesContainer

The container of the secure preferences. Objects implementing this interface are supplied to to various provider method calls to describe current context.

This interface is not intended to be implemented or extended by clients.

See Also:: PasswordProvider
Restriction:: This interface is not intended to be implemented by clients.
Restriction:: This interface is not intended to be extended by clients.

Method Summary

URL getLocation ()
          Returns location corresponding to the secure preferences.

Object getOption ( Object key)
          Returns an option specified for this container, or null if the option was not specified.

ISecurePreferences getPreferences ()
          Returns secure preferences contained in this container.

boolean hasOption ( Object key)
          Determines is a given option is specified for this container.

Method Detail

getLocation


URL getLocation()

Returns location corresponding to the secure preferences.

Returns:: location corresponding to the secure preferences

getPreferences


ISecurePreferences getPreferences()

Returns secure preferences contained in this container.

Returns:: root node of the secure preferences contained in this container

hasOption

boolean hasOption(
Object key)

Determines is a given option is specified for this container.

Parameters:: key - key describing the option
Returns:: true if container has this option; false otehrwise
See Also:: SecurePreferencesFactory.open(java.net.URL, java.util.Map), IProviderHints

getOption


Object getOption(
Object key)

Returns an option specified for this container, or null if the option was not specified.

Parameters:: key - describes the option
Returns:: value of the option for this container, or null the option was not specified