diff options
author | Uwe Stieber | 2012-12-08 10:31:26 +0000 |
---|---|---|
committer | Uwe Stieber | 2012-12-08 10:31:26 +0000 |
commit | 7e5f1ef7c6faa6b570b277488ec5d29cab1cb4ca (patch) | |
tree | bab73afb85b44212c80033c0cf269062f2463b88 /target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime | |
parent | b541f2002826600d1bcecd79aa38e5e1e51b99fc (diff) | |
download | org.eclipse.tcf-7e5f1ef7c6faa6b570b277488ec5d29cab1cb4ca.tar.gz org.eclipse.tcf-7e5f1ef7c6faa6b570b277488ec5d29cab1cb4ca.tar.xz org.eclipse.tcf-7e5f1ef7c6faa6b570b277488ec5d29cab1cb4ca.zip |
Target Explorer: Fix javadoc
Diffstat (limited to 'target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime')
-rw-r--r-- | target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime/persistence/interfaces/IURIPersistenceService.java | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime/persistence/interfaces/IURIPersistenceService.java b/target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime/persistence/interfaces/IURIPersistenceService.java index 9f2bf93ea..0a3e3cab9 100644 --- a/target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime/persistence/interfaces/IURIPersistenceService.java +++ b/target_explorer/plugins/org.eclipse.tcf.te.runtime.persistence/src/org/eclipse/tcf/te/runtime/persistence/interfaces/IURIPersistenceService.java @@ -1,71 +1,71 @@ -/*******************************************************************************
- * 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.persistence.interfaces;
-
-import java.io.IOException;
-import java.net.URI;
-
-import org.eclipse.tcf.te.runtime.services.interfaces.IService;
-
-/**
- * A service for persisting elements to a URI persistence store.
- */
-public interface IURIPersistenceService extends IService {
-
- /**
- * Writes the given context object via a persistence delegate to a persistence storage.
- * If the given URI is <code>null</code>, it will be determined by adapting the context
- * to a {@link IPersistableURIProvider}
- *
- * @param context The context object. Must not be <code>null</code>.
- * @param uri The URI or <code>null</code>.
- *
- * @throws IOException - if the operation fails.
- */
- public void write(Object context, URI uri) throws IOException;
-
- /**
- * Reads a context object via a persistence delegate from a given persistence storage.
- * If the given URI is <code>null</code>, it will be determined by adapting the context
- * to a {@link IPersistableURIProvider}. In this case the context must not be <code>null</code>.
- *
- * @param context The context object or <code>null</code>.
- * @param uri The URI. Must not be <code>null</code>.
- *
- * @throws IOException - if the operation fails
- */
- public Object read(Object context, URI uri) throws IOException;
-
- /**
- * Deletes the persistence storage for the given context object via a persistence delegate.
- * If the given URI is <code>null</code>, it will be determined by adapting the context
- * to a {@link IPersistableURIProvider}
- *
- * @param context The context object. Must not be <code>null</code>.
- * @param uri The URI or <code>null</code>.
- *
- * @return <code>True</code> if the persistence storage is successfully deleted;
- * <code>false</code> otherwise.
- *
- * @throws IOException - if the operation fails
- */
- public boolean delete(Object context, URI uri) throws IOException;
-
- /**
- * Returns the persistence storage URI for the given context object. The persistence delegate to
- * use will be determined by adapting the given context object to an {@link IPersistable}.
- *
- * @param context The context object. Must not be <code>null</code>.
- * @return The URI or <code>null</code>.
- *
- * @throws IOException - if the operation fails
- */
- public URI getURI(Object context) throws IOException;
-}
+/******************************************************************************* + * 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.persistence.interfaces; + +import java.io.IOException; +import java.net.URI; + +import org.eclipse.tcf.te.runtime.services.interfaces.IService; + +/** + * A service for persisting elements to a URI persistence store. + */ +public interface IURIPersistenceService extends IService { + + /** + * Writes the given context object via a persistence delegate to a persistence storage. + * If the given URI is <code>null</code>, it will be determined by adapting the context + * to a {@link IPersistableURIProvider} + * + * @param context The context object. Must not be <code>null</code>. + * @param uri The URI or <code>null</code>. + * + * @throws IOException - if the operation fails. + */ + public void write(Object context, URI uri) throws IOException; + + /** + * Reads a context object via a persistence delegate from a given persistence storage. + * If the given URI is <code>null</code>, it will be determined by adapting the context + * to a {@link IPersistableURIProvider}. + * + * @param context The context object. Must not be <code>null</code>. + * @param uri The URI or <code>null</code>. + * + * @throws IOException - if the operation fails + */ + public Object read(Object context, URI uri) throws IOException; + + /** + * Deletes the persistence storage for the given context object via a persistence delegate. + * If the given URI is <code>null</code>, it will be determined by adapting the context + * to a {@link IPersistableURIProvider} + * + * @param context The context object. Must not be <code>null</code>. + * @param uri The URI or <code>null</code>. + * + * @return <code>True</code> if the persistence storage is successfully deleted; + * <code>false</code> otherwise. + * + * @throws IOException - if the operation fails + */ + public boolean delete(Object context, URI uri) throws IOException; + + /** + * Returns the persistence storage URI for the given context object. The persistence delegate to + * use will be determined by adapting the given context object to an {@link IPersistable}. + * + * @param context The context object. Must not be <code>null</code>. + * @return The URI or <code>null</code>. + * + * @throws IOException - if the operation fails + */ + public URI getURI(Object context) throws IOException; +} |