Skip to content

Commit

Permalink
TEIIDDES-420: Add since annotations to all refactored classes
Browse files Browse the repository at this point in the history
* Since many classes have been refactored, they are effectively new classes
  when using the API Tooling analysis. These should all be tagged with the
  @SInCE annotation.
  • Loading branch information
Paul Richardson committed Jul 21, 2012
1 parent 8007f95 commit 8cd4b09
Show file tree
Hide file tree
Showing 3,016 changed files with 6,599 additions and 50 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
* return hc;
* }
* </PRE>
*
* @since 8.0
*/
public final class HashCodeUtil {

Expand Down
2 changes: 2 additions & 0 deletions plugins/org.teiid.core.designer/src/org/teiid/core/I18n.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
*
*
* @since 8.0
*/
public class I18n {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* UserCancelledException
*
* @since 8.0
*/
public class UserCancelledException extends TeiidRuntimeException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@

import static org.teiid.core.designer.CoreModelerPlugin.i18n;

/**
* @since 8.0
*/
public class CoreI18n {

public static final String EMPTY_ARGUMENT_MSG = i18n("emptyArgumentMsg"); //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

/**
* CorePlugin
*
* @since 8.0
*/
public class CoreModelerPlugin extends Plugin {
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,19 @@
import org.teiid.core.util.CoreStringUtil;
import org.teiid.core.util.FileUtils.Constants;

/**
* @since 8.0
*/
public final class FileUtil {

/**
* Constants for common file extensions.
*
* @since 6.0.0
*/
/**
* @since 8.0
*/
public interface Extensions {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
import org.teiid.core.util.CoreArgCheck;


/**
* @since 8.0
*/
public class FileUtils {

public static int DEFAULT_BUFFER_SIZE = 8092;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
*
*
* @since 8.0
*/
public final class OperationUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

/**
*
*
* @since 8.0
*/
public final class ZipUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
import org.teiid.core.util.CoreArgCheck;


/**
* @since 8.0
*/
abstract public class AbstractEventBroker extends AbstractEventSource implements EventBroker {
private static final String CANNOT_ADD_SELF_AS_LISTENER_MESSAGE = CorePlugin.Util.getString("AbstractEventBroker.CannotAddSelfAsListener"); //$NON-NLS-1$
private boolean shutdownRequested = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
import org.teiid.core.CorePlugin;
import org.teiid.core.util.CoreArgCheck;

/**
* @since 8.0
*/
abstract public class AbstractEventSource implements EventSource {

private static final String LISTENER_MAY_NOT_BE_NULL = CorePlugin.Util.getString("AbstractEventSource.The_event_listener_may_not_be_null"); //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,8 @@

package org.teiid.core.event;

/**
* @since 8.0
*/
public interface EventBroker extends EventSource, EventObjectListener {
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
import java.util.EventListener;
import java.util.EventObject;

/**
* @since 8.0
*/
public interface EventObjectListener extends EventListener {
void processEvent( EventObject obj );
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
package org.teiid.core.event;


/**
* @since 8.0
*/
public interface EventSource {

void addListener( Class eventClass,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
/**
* Subclasses of this exception typically only need to implement whatever constructors they need.
* <p>
*
* @since 8.0
*/
public class EventSourceException extends TeiidException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
/**
* The <code>IChangeListener</code> interface is informed of changes from a <code>IContentChangeNotifier</code>
* whom the listener is registered with.
*
* @since 8.0
*/
public interface IChangeListener {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* The <code>IChangeNotifier</code> interface provides a means for registering for change notification.
*
* @since 8.0
*/
public interface IChangeNotifier {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
import java.util.EventObject;
import org.teiid.core.CorePlugin;

/**
* @since 8.0
*/
public class SynchEventBroker extends AbstractEventBroker {

private static final String DEFAULT_NAME = CorePlugin.Util.getString("SynchEventBroker.DefaultName"); //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Thrown when a method argument is <code>null</code> or empty.
*
* @since 8.0
*/
public class EmptyArgumentException extends IllegalArgumentException {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import org.teiid.core.util.Assertion;


/**
* @since 8.0
*/
public class IntegerID implements ObjectID, Serializable {

public static final String PROTOCOL = "mmint"; //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@

import org.teiid.core.CorePlugin;

/**
* @since 8.0
*/
public class IntegerIDFactory implements ObjectIDFactory, Serializable {
private int lastID = 0;
public IntegerIDFactory() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
* Exception which occurs if an error occurs within the server that is not
* business-related. For instance, if a service or bean is not available
* or communication fails.
*
* @since 8.0
*/
public class InvalidIDException extends TeiidException {
private static final String INVALID_ID_MESSAGE = CorePlugin.Util.getString("InvalidIDException.Invalid_ID_1"); //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import org.teiid.core.util.Assertion;


/**
* @since 8.0
*/
public class LongID implements ObjectID, Serializable {
public static final String PROTOCOL = "mmlong"; //$NON-NLS-1$

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import org.teiid.core.CorePlugin;


/**
* @since 8.0
*/
public class LongIDFactory implements ObjectIDFactory, Serializable {
private long lastID = 0;
public LongIDFactory() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@



/**
* @since 8.0
*/
public interface ObjectID extends Comparable {

char DELIMITER = ':';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
/**
* The ObjectIDDescriptor defines the interface that is used to describe a particular type of
* {@link ObjectID}.
*
* @since 8.0
*/
public interface ObjectIDFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

/**
* ParsedObjectID
*
* @since 8.0
*/
public class ParsedObjectID {
private static final int DELIMITER_LENGTH = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import org.teiid.core.util.Assertion;


/**
* @since 8.0
*/
public class StringID implements ObjectID, Serializable {
public static final String PROTOCOL = "strid"; //$NON-NLS-1$

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@



/**
* @since 8.0
*/
public class StringIDFactory implements ObjectIDFactory {
private long lastID = 0;
public StringIDFactory() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@
* <p>All references in this code to bit positions as "least significant" and
* "most significant" refer to the bits moving from right to left, respectively.
* </p>
*
* @since 8.0
*/
public class UUIDFactory implements ObjectIDFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
* </ul>
* Note that if you do not shutdown the plugin framework after instantiating an application, the application will never terminate.
*
*
* @since 8.0
*/
public abstract class PluginUtilities {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* The <code>Property</code> class includes a property definition and a value.
*
* @since 8.0
*/
public interface Property {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* The attributes of a property.
*
* @since 8.0
*/
public interface PropertyDefinition {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* TreeSelection
*
* @since 8.0
*/
public interface TreeSelection {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

/**
* This utility class provides mechanisms for computing the checksum.
*
* @since 8.0
*/
public class ChecksumUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
* This class contains a set of static utility methods for checking method arguments. It contains many of the common checks that
* are done, such as checking that an Object is non-null, checking the range of a value, etc. All of these methods throw
* {@link IllegalArgumentException}.
*
* @since 8.0
*/
public class CoreArgCheck {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

/**
* This is a common place to put String utility methods.
*
* @since 8.0
*/
public final class CoreStringUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* IPathComparator
*
* @since 8.0
*/
public class IPathComparator implements Comparator {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
* Plug-ins that wish to utilize Eclipse's {@link NLS} i18n framework can instantiate this class instead of a
* {@link PluginUtilImpl}
*
*
* @since 8.0
*/
public class LoggingUtil implements PluginUtil {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* PlatformAwareFileSystemView
*
* @since 8.0
*/
public class OSPlatformUtil {
public static String OS_PROPERTY_NAME = "os.name"; //$NON-NLS-1$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@
* &lt;pluginpackage>.i18n_&lt;language2>.properties <BR>
* &lt;pluginpackage>.i18n.properties
* </p>
*
* @since 8.0
*/
public class PluginUtilImpl extends BundleUtil implements PluginUtil {

Expand Down

0 comments on commit 8cd4b09

Please sign in to comment.