From 511e584ff44657b0f4219292cddf130fa16b5e37 Mon Sep 17 00:00:00 2001 From: David McKnight Date: Thu, 3 Apr 2008 14:39:29 +0000 Subject: [PATCH] adding @since tags for new apis --- .../UI/org/eclipse/rse/ui/ISystemMessages.java | 12 ++++++++++++ .../rse/ui/propertypages/ServicesPropertyPage.java | 3 +++ .../rse/ui/view/ISystemPropertyConstants.java | 14 +++++++++++++- .../UI/org/eclipse/rse/ui/view/ISystemTree.java | 5 +++++ .../rse/ui/view/ISystemViewElementAdapter.java | 2 ++ .../eclipse/rse/ui/model/ISystemRegistryUI.java | 4 ++++ 6 files changed, 39 insertions(+), 1 deletion(-) diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemMessages.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemMessages.java index f830f3ca650..c02ebf29d40 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemMessages.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/ISystemMessages.java @@ -133,6 +133,9 @@ public interface ISystemMessages public static final String MSG_MOVEGENERIC_PROGRESS = "RSEG1116"; //$NON-NLS-1$ public static final String MSG_COPYTHINGGENERIC_PROGRESS = "RSEG1117"; //$NON-NLS-1$ public static final String MSG_MOVETHINGGENERIC_PROGRESS = "RSEG1118"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String MSG_RENAMEGENERIC_PROGRESS = "RSEG1142"; //$NON-NLS-1$ public static final String MSG_VALIDATE_SRCTYPE_EMPTY = "RSEG1192"; //$NON-NLS-1$ @@ -148,6 +151,9 @@ public interface ISystemMessages //public static final String MSG_OPERATION_PREFIX = MSG_PREFIX + "Operation."; public static final String MSG_OPERATION_FAILED = "RSEG1066"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String MSG_OPERATION_CANCELED = "RSEG1067"; //$NON-NLS-1$ @@ -162,6 +168,9 @@ public interface ISystemMessages // UNIVERSAL FILE MESSAGES... // -------------------------- public static final String FILEMSG_RENAME_INTERRUPTED = "RSEG1246"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String FILEMSG_DELETE_INTERRUPTED = "RSEG1247"; //$NON-NLS-1$ @@ -170,6 +179,9 @@ public interface ISystemMessages // -------------------------- //public static final String MSG_EXPAND_PREFIX = MSG_PREFIX + "Expand."; public static final String MSG_EXPAND_FAILED = "RSEG1098"; //MSG_EXPAND_PREFIX + "Failed"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String MSG_EXPAND_CANCELED = "RSEG1067"; //MSG_EXPAND_PREFIX + "Cancelled"; //$NON-NLS-1$ // Message vetoed by UCD //public static final String MSG_EXPAND_CANCELED = "RSEG1099"; //MSG_EXPAND_PREFIX + "Cancelled"; diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/propertypages/ServicesPropertyPage.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/propertypages/ServicesPropertyPage.java index 1daac2d2218..a01ed70868c 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/propertypages/ServicesPropertyPage.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/propertypages/ServicesPropertyPage.java @@ -67,6 +67,9 @@ public abstract class ServicesPropertyPage extends SystemBasePropertyPage protected abstract ServiceElement[] getServiceElements(); + /** + * @since 3.0 + */ protected abstract ISubSystemConfiguration getCurrentSubSystemConfiguration(); public boolean performOk() diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemPropertyConstants.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemPropertyConstants.java index f21e919c0e5..66d6a968287 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemPropertyConstants.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemPropertyConstants.java @@ -56,14 +56,26 @@ public interface ISystemPropertyConstants extends IBasicPropertyConstants public static final String P_FILE_PATH = P_PREFIX+"file.path"; //$NON-NLS-1$ public static final String P_FILE_CANONICAL_PATH = P_PREFIX+"file.canonicalpath"; //$NON-NLS-1$ public static final String P_FILE_CLASSIFICATION= P_PREFIX+"file.classification"; //$NON-NLS-1$ - public static final String P_FILE_EXTENSION = P_PREFIX+"file.extension"; + /** + * @since 3.0 + */ + public static final String P_FILE_EXTENSION = P_PREFIX+"file.extension"; //$NON-NLS-1$ public static final String P_FILE_READONLY = P_PREFIX+"file.readonly"; //$NON-NLS-1$ public static final String P_FILE_READABLE = P_PREFIX+"file.readable"; //$NON-NLS-1$ public static final String P_FILE_WRITABLE = P_PREFIX+"file.writable"; //$NON-NLS-1$ public static final String P_FILE_HIDDEN = P_PREFIX+"file.hidden"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String P_FILE_PERMISSIONS = P_PREFIX+"file.permissions"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String P_FILE_OWNER = P_PREFIX+"file.owner"; //$NON-NLS-1$ + /** + * @since 3.0 + */ public static final String P_FILE_GROUP = P_PREFIX+"file.group"; //$NON-NLS-1$ diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemTree.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemTree.java index ac24df16cfd..a9c43a3f6c2 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemTree.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemTree.java @@ -130,6 +130,7 @@ public interface ISystemTree { * @param remoteObject - The remote object to find. * @param parentItem - Optionally, the parent item to start the search at * @return TreeItem hit if found + * @since 3.0 */ public Item findFirstRemoteItemReference(Object remoteObject, Item parentItem); @@ -141,12 +142,14 @@ public interface ISystemTree { * @return the filter reference to the filter if found and expanded. This is a unique binary address * within the object's in this tree, so can be used in the viewer methods to affect this particular * node. + * @since 3.0 */ public ISystemFilterReference revealAndExpand(ISubSystem parentSubSystem, ISystemFilter filter); /** * Return the Tree widget * @return tree widget + * @since 3.0 */ public Tree getTree(); @@ -155,6 +158,7 @@ public interface ISystemTree { * * @param widget the parent item for the items to create * @param children the children to create items for + * @since 3.0 */ public void createTreeItems(TreeItem widget, Object[] children); @@ -171,6 +175,7 @@ public interface ISystemTree { * get a new List created and returned with the hits. * @return the List populated with hits, or null if null * was passed in as the List to populate and no hits were found. + * @since 3.0 */ public List findAllRemoteItemReferences(Object element, Object elementObject, List matches); diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewElementAdapter.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewElementAdapter.java index 9ec821b6321..ea762dd92a6 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewElementAdapter.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewElementAdapter.java @@ -184,6 +184,7 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD * * @param element the element to check * @return true if the element exists + * @since 3.0 */ public boolean exists(Object element); @@ -329,6 +330,7 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD public boolean canRename(Object element); /** * Perform the rename on the given item. + * @since 3.0 */ public boolean doRename(Shell shell, Object element, String name, IProgressMonitor monitor) throws Exception; diff --git a/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java b/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java index f5a2828967b..0af9b7300b8 100644 --- a/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java +++ b/rse/plugins/org.eclipse.rse.ui/model/org/eclipse/rse/ui/model/ISystemRegistryUI.java @@ -74,16 +74,19 @@ public interface ISystemRegistryUI extends ISystemShellProvider { // ---------------------------- /** * Are connection names to be qualified by profile name? + * @since 3.0 */ public boolean getQualifiedHostNames(); /** * Set if connection names are to be qualified by profile name + * @since 3.0 */ public void setQualifiedHostNames(boolean set); /** * Reflect the user changing the preference for showing filter pools. + * @since 3.0 */ public void setShowFilterPools(boolean show); @@ -94,6 +97,7 @@ public interface ISystemRegistryUI extends ISystemShellProvider { */ /** * Reflect the user changing the preference for showing new connection prompt + * @since 3.0 */ public void setShowNewHostPrompt(boolean show);