mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-18 13:45:45 +02:00
[cleanup] Cleanup Javadoc.
This commit is contained in:
Martin Oberhuber
parent
5dafb41140
commit
0abf88fa1b
3 changed files with 92 additions and 86 deletions
|
|
@ -1,5 +1,5 @@
|
|||
/*******************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others.
|
||||
* Copyright (c) 2002, 2008 IBM Corporation 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
|
||||
|
|
@ -12,7 +12,7 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* Martin Oberhuber (Wind River) - Cleanup Javadoc.
|
||||
*******************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.filters;
|
||||
|
|
@ -55,44 +55,41 @@ public interface ISystemFilterString extends IRSEBaseReferencedObject, IAdaptabl
|
|||
public void clone(ISystemFilterString targetString);
|
||||
|
||||
/**
|
||||
* Is this filter string changable? Depends on mof attributes of parent filter
|
||||
* Check if this filter string is changeable.
|
||||
* Depends on attributes of parent filter.
|
||||
*/
|
||||
public boolean isChangable();
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* @return The value of the String attribute
|
||||
*/
|
||||
String getString();
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* @param value The new value of the String attribute
|
||||
*/
|
||||
void setString(String value);
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* @return The value of the Type attribute
|
||||
* Returns the type attribute.
|
||||
* Intercepted to return SystemFilterConstants.DEFAULT_TYPE if it is currently null
|
||||
* Allows tools to have typed filter strings
|
||||
* @return The value of the Type attribute
|
||||
*/
|
||||
String getType();
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* @param value The new value of the Type attribute
|
||||
*/
|
||||
void setType(String value);
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* Check if this is a vendor-supplied filter string versus a user-defined filter string.
|
||||
* @return The value of the Default attribute
|
||||
* Is this a vendor-supplied filter string versus a user-defined filter string
|
||||
*/
|
||||
boolean isDefault();
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* @param value The new value of the Default attribute
|
||||
*/
|
||||
void setDefault(boolean value);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2006 IBM Corporation. All rights reserved.
|
||||
* Copyright (c) 2002, 2008 IBM Corporation 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
|
||||
|
|
@ -11,7 +11,7 @@
|
|||
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
|
||||
*
|
||||
* Contributors:
|
||||
* {Name} (company) - description of contribution.
|
||||
* Martin Oberhuber (Wind River) - Cleanup Javadoc.
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.core.references;
|
||||
|
|
@ -35,6 +35,7 @@ public interface IRSEBaseReferencedObject {
|
|||
public int removeReference(IRSEBaseReferencingObject ref);
|
||||
|
||||
/**
|
||||
* Return a count of how many referencing objects reference this object.
|
||||
* @return a count of how many referencing objects reference this object.
|
||||
*/
|
||||
public int getReferenceCount();
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/********************************************************************************
|
||||
* Copyright (c) 2002, 2007 IBM Corporation and others. All rights reserved.
|
||||
* Copyright (c) 2002, 2008 IBM Corporation 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
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
* Contributors:
|
||||
* David Dykstal (IBM) - 142806: refactoring persistence framework
|
||||
* Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
|
||||
* Martin Oberhuber (Wind River) - Cleanup Javadoc.
|
||||
********************************************************************************/
|
||||
|
||||
package org.eclipse.rse.internal.core.filters;
|
||||
|
|
@ -33,9 +34,6 @@ import org.eclipse.rse.internal.references.SystemReferencedObjectHelper;
|
|||
/**
|
||||
* This represents a filter string within a filter. Filters can hold one or more filter strings.
|
||||
*/
|
||||
/**
|
||||
* @lastgen class SystemFilterStringImpl Impl implements SystemFilterString, IAdaptable {}
|
||||
*/
|
||||
public class SystemFilterString extends RSEModelObject implements ISystemFilterString, IAdaptable
|
||||
{
|
||||
private ISystemFilter parentFilter;
|
||||
|
|
@ -43,42 +41,23 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
|
||||
/**
|
||||
* The default value of the '{@link #getString() <em>String</em>}' attribute.
|
||||
* <!-- begin-user-doc -->
|
||||
* <!-- end-user-doc -->
|
||||
* @see #getString()
|
||||
* @generated
|
||||
* @ordered
|
||||
*/
|
||||
protected static final String STRING_EDEFAULT = null;
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
*/
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
*/
|
||||
protected String string = STRING_EDEFAULT;
|
||||
|
||||
/**
|
||||
* The default value of the '{@link #getType() <em>Type</em>}' attribute.
|
||||
* <!-- begin-user-doc -->
|
||||
* <!-- end-user-doc -->
|
||||
* @see #getType()
|
||||
* @generated
|
||||
* @ordered
|
||||
*/
|
||||
protected static final String TYPE_EDEFAULT = null;
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
*/
|
||||
protected String type = TYPE_EDEFAULT;
|
||||
|
||||
/**
|
||||
* The default value of the '{@link #isDefault() <em>Default</em>}' attribute.
|
||||
* <!-- begin-user-doc -->
|
||||
* <!-- end-user-doc -->
|
||||
* @see #isDefault()
|
||||
* @generated
|
||||
* @ordered
|
||||
*/
|
||||
protected static final boolean DEFAULT_EDEFAULT = false;
|
||||
|
||||
|
|
@ -86,40 +65,46 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
* @generated This field/method will be replaced during code generation.
|
||||
*/
|
||||
protected boolean default_ = DEFAULT_EDEFAULT;
|
||||
/**
|
||||
* Constructor. Do not instantiate yourself! Let MOF do it!
|
||||
|
||||
/**
|
||||
* Constructor. Do not instantiate yourself!
|
||||
*/
|
||||
protected SystemFilterString()
|
||||
{
|
||||
super();
|
||||
helper = new SystemReferencedObjectHelper(this);
|
||||
}
|
||||
/**
|
||||
* This is the method required by the IAdaptable interface.
|
||||
* Given an adapter class type, return an object castable to the type, or
|
||||
* null if this is not possible.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
|
||||
*/
|
||||
public Object getAdapter(Class adapterType)
|
||||
{
|
||||
return Platform.getAdapterManager().getAdapter(this, adapterType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the transient parent back-pointer. Called by framework at restore/create time.
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#setParentSystemFilter(org.eclipse.rse.core.filters.ISystemFilter)
|
||||
*/
|
||||
public void setParentSystemFilter(ISystemFilter filter)
|
||||
{
|
||||
this.parentFilter = filter;
|
||||
}
|
||||
/**
|
||||
* Get the parent filter that contains this filter string.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#getParentSystemFilter()
|
||||
*/
|
||||
public ISystemFilter getParentSystemFilter()
|
||||
{
|
||||
return parentFilter;
|
||||
}
|
||||
/**
|
||||
* Return the caller which instantiated the filter pool manager overseeing this filter framework instance
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#getProvider()
|
||||
*/
|
||||
public ISystemFilterPoolManagerProvider getProvider()
|
||||
{
|
||||
|
|
@ -128,8 +113,10 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
else
|
||||
return null;
|
||||
}
|
||||
/**
|
||||
* Return the filter pool manager managing this collection of filter pools and their filters and their filter strings.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#getSystemFilterPoolManager()
|
||||
*/
|
||||
public ISystemFilterPoolManager getSystemFilterPoolManager()
|
||||
{
|
||||
|
|
@ -137,9 +124,11 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
return parentFilter.getSystemFilterPoolManager();
|
||||
else
|
||||
return null;
|
||||
}
|
||||
/**
|
||||
* Returns the type attribute. Intercepted to return SystemFilterConstants.DEFAULT_TYPE if it is currently null
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#getType()
|
||||
*/
|
||||
public String getType()
|
||||
{
|
||||
|
|
@ -149,8 +138,10 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
else
|
||||
return type;
|
||||
}
|
||||
/**
|
||||
* Clones this filter string's attributes into the given filter string
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#clone(org.eclipse.rse.core.filters.ISystemFilterString)
|
||||
*/
|
||||
public void clone(ISystemFilterString targetString)
|
||||
{
|
||||
|
|
@ -161,8 +152,9 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
targetString.setDefault(isDefault());
|
||||
}
|
||||
|
||||
/**
|
||||
* Is this filter string changable? Depends on mof attributes of parent filter
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#isChangable()
|
||||
*/
|
||||
public boolean isChangable()
|
||||
{
|
||||
|
|
@ -174,45 +166,56 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
// ----------------------------------
|
||||
// IRSEReferencedObject methods...
|
||||
// ----------------------------------
|
||||
/**
|
||||
* Add a reference, increment reference count, return new count
|
||||
* @return new count of how many referencing objects reference this object.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.references.IRSEBaseReferencedObject#addReference(org.eclipse.rse.core.references.IRSEBaseReferencingObject)
|
||||
*/
|
||||
public int addReference(IRSEBaseReferencingObject ref)
|
||||
{
|
||||
return helper.addReference(ref);
|
||||
}
|
||||
/**
|
||||
* Remove a reference, decrement reference count, return new count
|
||||
* @return new count of how many referencing objects reference this object.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.references.IRSEBaseReferencedObject#removeReference(org.eclipse.rse.core.references.IRSEBaseReferencingObject)
|
||||
*/
|
||||
public int removeReference(IRSEBaseReferencingObject ref)
|
||||
{
|
||||
return helper.removeReference(ref);
|
||||
}
|
||||
/**
|
||||
* Return a count of how many referencing objects reference this object.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.references.IRSEBaseReferencedObject#getReferenceCount()
|
||||
*/
|
||||
public int getReferenceCount()
|
||||
{
|
||||
return helper.getReferenceCount();
|
||||
}
|
||||
/**
|
||||
* Clear the list of referenced objects.
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.references.IRSEBaseReferencedObject#removeAllReferences()
|
||||
*/
|
||||
public void removeAllReferences()
|
||||
{
|
||||
helper.removeAllReferences();
|
||||
}
|
||||
/**
|
||||
* Return a list of all referencing objects of this object
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.references.IRSEBaseReferencedObject#getReferencingObjects()
|
||||
*/
|
||||
public IRSEBaseReferencingObject[] getReferencingObjects()
|
||||
{
|
||||
return helper.getReferencingObjects();
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.model.IRSEModelObject#getName()
|
||||
*/
|
||||
public String getName()
|
||||
{
|
||||
return getString();
|
||||
|
|
@ -223,51 +226,57 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
return RSECoreMessages.RESID_MODELOBJECTS_FILTERSTRING_DESCRIPTION;
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#getString()
|
||||
*/
|
||||
public String getString()
|
||||
{
|
||||
return string;
|
||||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#setString(java.lang.String)
|
||||
*/
|
||||
public void setString(String newString)
|
||||
{
|
||||
string = newString;
|
||||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#setType(java.lang.String)
|
||||
*/
|
||||
public void setType(String newType)
|
||||
{
|
||||
type = newType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* Is this a vendor-supplied filter string versus a user-defined filter string
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#isDefault()
|
||||
*/
|
||||
public boolean isDefault()
|
||||
{
|
||||
return default_;
|
||||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.filters.ISystemFilterString#setDefault(boolean)
|
||||
*/
|
||||
public void setDefault(boolean newDefault)
|
||||
{
|
||||
default_ = newDefault;
|
||||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation.
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
* @see java.lang.Object#toString()
|
||||
*/
|
||||
public String toString()
|
||||
{
|
||||
|
||||
|
||||
StringBuffer result = new StringBuffer(super.toString());
|
||||
result.append(" (string: "); //$NON-NLS-1$
|
||||
result.append(string);
|
||||
|
|
@ -280,7 +289,6 @@ public class SystemFilterString extends RSEModelObject implements ISystemFilterS
|
|||
}
|
||||
|
||||
/**
|
||||
* @generated This field/method will be replaced during code generation
|
||||
* Allows tools to have typed filter strings
|
||||
*/
|
||||
public String getTypeGen()
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue