CompletionProposal.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.phpdt.core |
 |
 |
PHPeclipse |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| COMMENT_DENSITY | Comment density | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| COMPARISONS | Number of comparison operators | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| OPERANDS | Number of operands | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| ELOC | Effective lines of code | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| EXITS | Procedure exits | |
| PROGRAM_LENGTH | Halstead program length | |
| LOC | Lines of code | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| CYCLOMATIC | Cyclomatic complexity | |
/*******************************************************************************
* Copyright (c) 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.phpdt.core;
import net.sourceforge.phpdt.core.compiler.CharOperation;
import org.eclipse.core.runtime.IProgressMonitor;
/**
* Completion proposal.
* <p>
* In typical usage, the user working in a Java code editor issues a code assist
* command. This command results in a call to
* <code>ICodeAssist.codeComplete(position, completionRequestor)</code>
* passing the current position in the source code. The code assist engine
* analyzes the code in the buffer, determines what kind of Java language
* construct is at that position, and proposes ways to complete that construct.
* These proposals are instances of subclasses of
* <code>CompletionProposal</code>. These proposals, perhaps after sorting
* and filtering, are presented to the user to make a choice.
* </p>
* <p>
* The proposal is as follows: insert the
* {@linkplain #getCompletion() completion string} into the source file buffer,
* replacing the characters between {@linkplain #getReplaceStart() the start}
* and {@linkplain #getReplaceEnd() end}. The string can be arbitrary; for
* example, it might include not only the name of a method but a set of
* parentheses. Moreover, the source range may include source positions before
* or after the source position where <code>ICodeAssist.codeComplete</code>
* was invoked. The rest of the information associated with the proposal is to
* provide context that may help a user to choose from among competing
* proposals.
* </p>
* <p>
* The completion engine creates instances of this class; it is not intended to
* be used by other clients.
* </p>
*
* @see ICodeAssist#codeComplete(int, CompletionRequestor)
* @since 3.0
*/
public final class CompletionProposal {
/**
* Completion is a declaration of an anonymous class. This kind of
* completion might occur in a context like <code>"new List^;"</code> and
* complete it to <code>"new List() {}"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the type signature of the type
* being implemented or subclassed </li>
* </li>
* <li>{@link #getSignature()} - the method signature of the constructor
* that is referenced </li>
* <li>{@link #getFlags()} - the modifiers flags of the constructor that is
* referenced </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int ANONYMOUS_CLASS_DECLARATION = 1;
/**
* Completion is a reference to a field. This kind of completion might occur
* in a context like <code>"this.ref^ = 0;"</code> and complete it to
* <code>"this.refcount = 0;"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the type signature of the type
* that declares the field that is referenced </li>
* <li>{@link #getFlags()} - the modifiers flags (including ACC_ENUM) of
* the field that is referenced </li>
* <li>{@link #getName()} - the simple name of the field that is referenced
* </li>
* <li>{@link #getSignature()} - the type signature of the field's type (as
* opposed to the signature of the type in which the referenced field is
* declared) </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int FIELD_REF = 2;
/**
* Completion is a keyword. This kind of completion might occur in a context
* like <code>"public cl^ Foo {}"</code> and complete it to
* <code>"public class Foo {}"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getName()} - the keyword token </li>
* <li>{@link #getFlags()} - the corresponding modifier flags if the
* keyword is a modifier </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int KEYWORD = 3;
/**
* Completion is a reference to a label. This kind of completion might occur
* in a context like <code>"break lo^;"</code> and complete it to
* <code>"break loop;"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getName()} - the simple name of the label that is referenced
* </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int LABEL_REF = 4;
/**
* Completion is a reference to a local variable. This kind of completion
* might occur in a context like <code>"ke^ = 4;"</code> and complete it
* to <code>"keys = 4;"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getFlags()} - the modifiers flags of the local variable that
* is referenced </li>
* <li>{@link #getName()} - the simple name of the local variable that is
* referenced </li>
* <li>{@link #getSignature()} - the type signature of the local variable's
* type </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int LOCAL_VARIABLE_REF = 5;
/**
* Completion is a reference to a method. This kind of completion might
* occur in a context like <code>"System.out.pr^();"</code> and complete
* it to <code>""System.out.println();"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the type signature of the type
* that declares the method that is referenced </li>
* <li>{@link #getFlags()} - the modifiers flags of the method that is
* referenced </li>
* <li>{@link #getName()} - the simple name of the method that is
* referenced </li>
* <li>{@link #getSignature()} - the method signature of the method that is
* referenced </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int METHOD_REF = 6;
/**
* Completion is a declaration of a method. This kind of completion might
* occur in a context like <code>"new List() {si^};"</code> and complete
* it to <code>"new List() {public int size() {} };"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the type signature of the type
* that declares the method that is being overridden or implemented </li>
* <li>{@link #getName()} - the simple name of the method that is being
* overridden or implemented </li>
* <li>{@link #getSignature()} - the method signature of the method that is
* being overridden or implemented </li>
* <li>{@link #getFlags()} - the modifiers flags of the method that is
* being overridden or implemented </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int METHOD_DECLARATION = 7;
/**
* Completion is a reference to a package. This kind of completion might
* occur in a context like <code>"import java.u^.*;"</code> and complete
* it to <code>"import java.util.*;"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the dot-based package signature
* of the package that is referenced </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int PACKAGE_REF = 8;
/**
* Completion is a reference to a type. Any kind of type is allowed,
* including primitive types, reference types, array types, parameterized
* types, and type variables. This kind of completion might occur in a
* context like <code>"public static Str^ key;"</code> and complete it to
* <code>"public static String key;"</code>.
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getDeclarationSignature()} - the dot-based package signature
* of the package that contains the type that is referenced </li>
* <li>{@link #getSignature()} - the type signature of the type that is
* referenced </li>
* <li>{@link #getFlags()} - the modifiers flags (including
* Flags.AccInterface, AccEnum, and AccAnnotation) of the type that is
* referenced </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int TYPE_REF = 9;
/**
* Completion is a declaration of a variable (locals, parameters, fields,
* etc.).
* <p>
* The following additional context information is available for this kind
* of completion proposal at little extra cost:
* <ul>
* <li>{@link #getName()} - the simple name of the variable being declared
* </li>
* <li>{@link #getSignature()} - the type signature of the type of the
* variable being declared </li>
* <li>{@link #getFlags()} - the modifiers flags of the variable being
* declared </li>
* </ul>
* </p>
*
* @see #getKind()
*/
public static final int VARIABLE_DECLARATION = 10;
/**
* Kind of completion request.
*/
private int completionKind;
/**
* Offset in original buffer where ICodeAssist.codeComplete() was requested.
*/
private int completionLocation;
/**
* Start position (inclusive) of source range in original buffer containing
* the relevant token defaults to empty subrange at [0,0).
*/
private int tokenStart = 0;
/**
* End position (exclusive) of source range in original buffer containing
* the relevant token; defaults to empty subrange at [0,0).
*/
private int tokenEnd = 0;
/**
* Completion string; defaults to empty string.
*/
private char[] completion = CharOperation.NO_CHAR;
/**
* Start position (inclusive) of source range in original buffer to be
* replaced by completion string; defaults to empty subrange at [0,0).
*/
private int replaceStart = 0;
/**
* End position (exclusive) of source range in original buffer to be
* replaced by completion string; defaults to empty subrange at [0,0).
*/
private int replaceEnd = 0;
/**
* Relevance rating; positive; higher means better; defaults to minimum
* rating.
*/
private int relevance = 1;
/**
* Signature of the relevant package or type declaration in the context, or
* <code>null</code> if none. Defaults to null.
*/
private char[] declarationSignature = null;
/**
* Simple name of the method, field, member, or variable relevant in the
* context, or <code>null</code> if none. Defaults to null.
*/
private char[] name = null;
/**
* Signature of the method, field type, member type, relevant in the
* context, or <code>null</code> if none. Defaults to null.
*/
private char[] signature = null;
/**
* Modifier flags relevant in the context, or <code>Flags.AccDefault</code>
* if none. Defaults to <code>Flags.AccDefault</code>.
*/
private int flags = Flags.AccDefault;
/**
* Parameter names (for method completions), or <code>null</code> if none.
* Lazily computed. Defaults to <code>null</code>.
*/
private char[][] parameterNames = null;
/**
* Indicates whether parameter names have been computed.
*/
private boolean parameterNamesComputed = false;
/**
* Creates a basic completion proposal. All instance field have plausible
* default values unless otherwise noted.
* <p>
* Note that the constructors for this class are internal to the Java model
* implementation. Clients cannot directly create CompletionProposal
* objects.
* </p>
*
* @param kind
* one of the kind constants declared on this class
* @param completionOffset
* original offset of code completion request
* @return a new completion proposal
*/
public static CompletionProposal create(int kind, int completionOffset) {
return new CompletionProposal(kind, completionOffset);
}
/**
* Creates a basic completion proposal. All instance field have plausible
* default values unless otherwise noted.
* <p>
* Note that the constructors for this class are internal to the Java model
* implementation. Clients cannot directly create CompletionProposal
* objects.
* </p>
*
* @param kind
* one of the kind constants declared on this class
* @param completionLocation
* original offset of code completion request
*/
CompletionProposal(int kind, int completionLocation) {
if ((kind < CompletionProposal.ANONYMOUS_CLASS_DECLARATION)
|| (kind > CompletionProposal.VARIABLE_DECLARATION)) {
throw new IllegalArgumentException();
}
if (this.completion == null || completionLocation < 0) {
throw new IllegalArgumentException();
}
this.completionKind = kind;
this.completionLocation = completionLocation;
}
/**
* Returns the kind of completion being proposed.
* <p>
* The set of different kinds of completion proposals is expected to change
* over time. It is strongly recommended that clients do <b>not</b> assume
* that the kind is one of the ones they know about, and code defensively
* for the possibility of unexpected future growth.
* </p>
*
* @return the kind; one of the kind constants declared on this class, or
* possibly a kind unknown to the caller
*/
public int getKind() {
return this.completionKind;
}
/**
* Returns the character index in the source file buffer where source
* completion was requested (the <code>offset</code>parameter to
* <code>ICodeAssist.codeComplete</code>.
*
* @return character index in source file buffer
* @see ICodeAssist#codeComplete(int,CompletionRequestor)
*/
public int getCompletionLocation() {
return this.completionLocation;
}
/**
* Returns the character index of the start of the subrange in the source
* file buffer containing the relevant token being completed. This token is
* either the identifier or Java language keyword under, or immediately
* preceding, the original request offset. If the original request offset is
* not within or immediately after an identifier or keyword, then the
* position returned is original request offset and the token range is
* empty.
*
* @return character index of token start position (inclusive)
*/
public int getTokenStart() {
return this.tokenStart;
}
/**
* Returns the character index of the end (exclusive) of the subrange in the
* source file buffer containing the relevant token. When there is no
* relevant token, the range is empty (<code>getEndToken() == getStartToken()</code>).
*
* @return character index of token end position (exclusive)
*/
public int getTokenEnd() {
return this.tokenEnd;
}
/**
* Sets the character indices of the subrange in the source file buffer
* containing the relevant token being completed. This token is either the
* identifier or Java language keyword under, or immediately preceding, the
* original request offset. If the original request offset is not within or
* immediately after an identifier or keyword, then the source range begins
* at original request offset and is empty.
* <p>
* If not set, defaults to empty subrange at [0,0).
* </p>
*
* @param startIndex
* character index of token start position (inclusive)
* @param endIndex
* character index of token end position (exclusive)
*/
public void setTokenRange(int startIndex, int endIndex) {
if (startIndex < 0 || endIndex < startIndex) {
throw new IllegalArgumentException();
}
this.tokenStart = startIndex;
this.tokenEnd = endIndex;
}
/**
* Returns the proposed sequence of characters to insert into the source
* file buffer, replacing the characters at the specified source range. The
* string can be arbitrary; for example, it might include not only the name
* of a method but a set of parentheses.
* <p>
* The client must not modify the array returned.
* </p>
*
* @return the completion string
*/
public char[] getCompletion() {
return this.completion;
}
/**
* Sets the proposed sequence of characters to insert into the source file
* buffer, replacing the characters at the specified source range. The
* string can be arbitrary; for example, it might include not only the name
* of a method but a set of parentheses.
* <p>
* If not set, defaults to an empty character array.
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param completion
* the completion string
*/
public void setCompletion(char[] completion) {
this.completion = completion;
}
/**
* Returns the character index of the start of the subrange in the source
* file buffer to be replaced by the completion string. If the subrange is
* empty (<code>getReplaceEnd() == getReplaceStart()</code>), the
* completion string is to be inserted at this index.
* <p>
* Note that while the token subrange is precisely specified, the
* replacement range is loosely constrained and may not bear any direct
* relation to the original request offset. For example, a it would be
* possible for a type completion to propose inserting an import declaration
* at the top of the compilation unit; or the completion might include
* trailing parentheses and punctuation for a method completion.
* </p>
*
* @return replacement start position (inclusive)
*/
public int getReplaceStart() {
return this.replaceStart;
}
/**
* Returns the character index of the end of the subrange in the source file
* buffer to be replaced by the completion string. If the subrange is empty (<code>getReplaceEnd() == getReplaceStart()</code>),
* the completion string is to be inserted at this index.
*
* @return replacement end position (exclusive)
*/
public int getReplaceEnd() {
return this.replaceEnd;
}
/**
* Sets the character indices of the subrange in the source file buffer to
* be replaced by the completion string. If the subrange is empty (<code>startIndex == endIndex</code>),
* the completion string is to be inserted at this index.
* <p>
* If not set, defaults to empty subrange at [0,0).
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param startIndex
* character index of replacement start position (inclusive)
* @param endIndex
* character index of replacement end position (exclusive)
*/
public void setReplaceRange(int startIndex, int endIndex) {
if (startIndex < 0 || endIndex < startIndex) {
throw new IllegalArgumentException();
}
this.replaceStart = startIndex;
this.replaceEnd = endIndex;
}
/**
* Returns the relative relevance rating of this proposal.
*
* @return relevance rating of this proposal; ratings are positive; higher
* means better
*/
public int getRelevance() {
return this.relevance;
}
/**
* Sets the relative relevance rating of this proposal.
* <p>
* If not set, defaults to the lowest possible rating (1).
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param rating
* relevance rating of this proposal; ratings are positive;
* higher means better
*/
public void setRelevance(int rating) {
if (rating <= 0) {
throw new IllegalArgumentException();
}
this.relevance = rating;
}
/**
* Returns the type or package signature of the relevant declaration in the
* context, or <code>null</code> if none.
* <p>
* This field is available for the following kinds of completion proposals:
* <ul>
* <li><code>ANONYMOUS_CLASS_DECLARATION</code> - type signature of the
* type that is being subclassed or implemented</li>
* <li><code>FIELD_REF</code> - type signature of the type that declares
* the field that is referenced</li>
* <li><code>METHOD_REF</code> - type signature of the type that declares
* the method that is referenced</li>
* <li><code>METHOD_DECLARATION</code> - type signature of the type that
* declares the method that is being implemented or overridden</li>
* <li><code>PACKAGE_REF</code> - dot-based package signature of the
* package that is referenced</li>
* <li><code>TYPE_REF</code> - dot-based package signature of the package
* containing the type that is referenced</li>
* </ul>
* For kinds of completion proposals, this method returns <code>null</code>.
* Clients must not modify the array returned.
* </p>
*
* @return the declaration signature, or <code>null</code> if none
* @see Signature
*/
public char[] getDeclarationSignature() {
return this.declarationSignature;
}
/**
* Sets the type or package signature of the relevant declaration in the
* context, or <code>null</code> if none.
* <p>
* If not set, defaults to none.
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param signature
* the type or package signature, or <code>null</code> if none
*/
public void setDeclarationSignature(char[] signature) {
this.declarationSignature = signature;
}
/**
* Returns the simple name of the method, field, member, or variable
* relevant in the context, or <code>null</code> if none.
* <p>
* This field is available for the following kinds of completion proposals:
* <ul>
* <li><code>FIELD_REF</code> - the name of the field</li>
* <li><code>KEYWORD</code> - the keyword</li>
* <li><code>LABEL_REF</code> - the name of the label</li>
* <li><code>LOCAL_VARIABLE_REF</code> - the name of the local variable</li>
* <li><code>METHOD_REF</code> - the name of the method</li>
* <li><code>METHOD_DECLARATION</code> - the name of the method</li>
* <li><code>VARIABLE_DECLARATION</code> - the name of the variable</li>
* </ul>
* For kinds of completion proposals, this method returns <code>null</code>.
* Clients must not modify the array returned.
* </p>
*
* @return the keyword, field, method, local variable, or member name, or
* <code>null</code> if none
*/
public char[] getName() {
return this.name;
}
/**
* Sets the simple name of the method, field, member, or variable relevant
* in the context, or <code>null</code> if none.
* <p>
* If not set, defaults to none.
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param name
* the keyword, field, method, local variable, or member name, or
* <code>null</code> if none
*/
public void setName(char[] name) {
this.name = name;
}
/**
* Returns the signature of the method or type relevant in the context, or
* <code>null</code> if none.
* <p>
* This field is available for the following kinds of completion proposals:
* <ul>
* <li><code>ANONYMOUS_CLASS_DECLARATION</code> - method signature of the
* constructor that is being invoked</li>
* <li><code>FIELD_REF</code> - the type signature of the referenced
* field's type</li>
* <li><code>LOCAL_VARIABLE_REF</code> - the type signature of the
* referenced local variable's type</li>
* <li><code>METHOD_REF</code> - method signature of the method that is
* referenced</li>
* <li><code>METHOD_DECLARATION</code> - method signature of the method
* that is being implemented or overridden</li>
* <li><code>TYPE_REF</code> - type signature of the type that is
* referenced</li>
* <li><code>VARIABLE_DECLARATION</code> - the type signature of the type
* of the variable being declared</li>
* </ul>
* For kinds of completion proposals, this method returns <code>null</code>.
* Clients must not modify the array returned.
* </p>
*
* @return the signature, or <code>null</code> if none
* @see Signature
*/
public char[] getSignature() {
return this.signature;
}
/**
* Sets the signature of the method, field type, member type, relevant in
* the context, or <code>null</code> if none.
* <p>
* If not set, defaults to none.
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param signature
* the signature, or <code>null</code> if none
*/
public void setSignature(char[] signature) {
this.signature = signature;
}
/**
* Returns the modifier flags relevant in the context, or
* <code>Flags.AccDefault</code> if none.
* <p>
* This field is available for the following kinds of completion proposals:
* <ul>
* <li><code>ANONYMOUS_CLASS_DECLARATION</code> - modifier flags of the
* constructor that is referenced</li>
* <li><code>FIELD_REF</code> - modifier flags of the field that is
* referenced; <code>Flags.AccEnum</code> can be used to recognize
* references to enum constants </li>
* <li><code>KEYWORD</code> - modifier flag corrresponding to the
* modifier keyword</li>
* <li><code>LOCAL_VARIABLE_REF</code> - modifier flags of the local
* variable that is referenced</li>
* <li><code>METHOD_REF</code> - modifier flags of the method that is
* referenced; <code>Flags.AccAnnotation</code> can be used to recognize
* references to annotation type members </li>
* <li><code>METHOD_DECLARATION</code> - modifier flags for the method
* that is being implemented or overridden</li>
* <li><code>TYPE_REF</code> - modifier flags of the type that is
* referenced; <code>Flags.AccInterface</code> can be used to recognize
* references to interfaces, <code>Flags.AccEnum</code> enum types, and
* <code>Flags.AccAnnotation</code> annotation types </li>
* <li><code>VARIABLE_DECLARATION</code> - modifier flags for the
* variable being declared</li>
* </ul>
* For kinds of completion proposals, this method returns
* <code>Flags.AccDefault</code>.
* </p>
*
* @return the modifier flags, or <code>Flags.AccDefault</code> if none
* @see Flags
*/
public int getFlags() {
return this.flags;
}
/**
* Sets the modifier flags relevant in the context.
* <p>
* If not set, defaults to none.
* </p>
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param flags
* the modifier flags, or <code>Flags.AccDefault</code> if none
*/
public void setFlags(int flags) {
this.flags = flags;
}
/**
* Finds the method parameter names. This information is relevant to method
* reference (and method declaration proposals). Returns <code>null</code>
* if not available or not relevant.
* <p>
* The client must not modify the array returned.
* </p>
* <p>
* <b>Note that this is an expensive thing to compute, which may require
* parsing Java source files, etc. Use sparingly.
* </p>
*
* @param monitor
* the progress monitor, or <code>null</code> if none
* @return the parameter names, or <code>null</code> if none or not
* available or not relevant
*/
public char[][] findParameterNames(IProgressMonitor monitor) {
if (!this.parameterNamesComputed) {
this.parameterNamesComputed = true;
// TODO (jerome) - Missing implementation
}
return this.parameterNames;
}
/**
* Sets the method parameter names. This information is relevant to method
* reference (and method declaration proposals).
* <p>
* The completion engine creates instances of this class and sets its
* properties; this method is not intended to be used by other clients.
* </p>
*
* @param parameterNames
* the parameter names, or <code>null</code> if none
*/
public void setParameterNames(char[][] parameterNames) {
this.parameterNames = parameterNames;
this.parameterNamesComputed = true;
}
}
The table below shows all metrics for CompletionProposal.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 30.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 648.00 | Comment lines | |
| COMMENT_DENSITY | 6.97 | Comment density | |
| COMPARISONS | 9.00 | Number of comparison operators | |
| CYCLOMATIC | 34.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 50.00 | Comments in declarations | |
| DOC_COMMENT | 647.00 | Number of javadoc comment lines | |
| ELOC | 93.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 24.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 32.69 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 45.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 781.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 5.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 5.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 823.00 | Number of lines in the source file | |
| LINE_COMMENT | 1.00 | Number of line comments | |
| LOC | 124.00 | Lines of code | |
| LOGICAL_LINES | 61.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 2.00 | Maximum nesting depth | |
| OPERANDS | 170.00 | Number of operands | |
| OPERATORS | 541.00 | Number of operators | |
| PARAMS | 16.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 711.00 | Halstead program length | |
| PROGRAM_VOCAB | 126.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 29.00 | Number of return points from functions | |
| SIZE | 28767.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 91.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 35.00 | Number of unique operators | |
| WHITESPACE | 51.00 | Number of whitespace lines | |