Skip to content

Commit f82339e

Browse files
committed
Remove bad comment refactoring and add description for use of internal name on elements that do not define an internal name according to the documentation.
1 parent da712db commit f82339e

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

byte-buddy-dep/src/main/java/net/bytebuddy/description/NamedElement.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public interface NamedElement {
3131
String EMPTY_NAME = "";
3232

3333
/**
34-
* Returns the name of this element as it is found in the source code. If no such name exists,
34+
* Returns the display name of this element as it is found in the source code. If no such name exists,
3535
* an empty string is returned.
3636
*
3737
* @return The name of this element as given in a Java program's source code.
@@ -44,16 +44,18 @@ public interface NamedElement {
4444
interface WithRuntimeName extends NamedElement {
4545

4646
/**
47-
* Returns the internalName of this byte code element.
47+
* Returns the binary name of this byte code element. If no well-defined internal name is known for this element,
48+
* the actual name is returned.
4849
*
49-
* @return The internalName of this byte code element as visible from within a running Java application.
50+
* @return The binary ame of this byte code element as visible from within a running Java application.
5051
*/
5152
String getName();
5253

5354
/**
54-
* Returns the internal internalName of this byte code element.
55+
* Returns the internal name of this byte code element. If no well-defined internal name is known for this element,
56+
* the actual name is returned.
5557
*
56-
* @return The internal internalName of this byte code element as used within the Java class file format.
58+
* @return The internal name of this byte code element as used within the Java class file format.
5759
*/
5860
String getInternalName();
5961
}

byte-buddy-dep/src/main/java/net/bytebuddy/description/type/TypeDescription.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,9 +228,9 @@ public interface TypeDescription extends TypeDefinition, ByteCodeElement, TypeVa
228228
int getActualModifiers(boolean superFlag);
229229

230230
/**
231-
* Returns the simple internalName of this type.
231+
* Returns the simple name of this type.
232232
*
233-
* @return The simple internalName of this type.
233+
* @return The simple name of this type.
234234
*/
235235
String getSimpleName();
236236

byte-buddy-dep/src/main/java/net/bytebuddy/implementation/bind/MethodNameEqualityResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
/**
2121
* Implementation of an
2222
* {@link net.bytebuddy.implementation.bind.MethodDelegationBinder.AmbiguityResolver}
23-
* that resolves conflicting bindings by considering equality of a target method's internalName as an indicator for a dominant
23+
* that resolves conflicting bindings by considering equality of a target method's name as an indicator for a dominant
2424
* binding.
2525
* <p>&nbsp;</p>
2626
* For example, if method {@code source.foo} can be bound to methods {@code targetA.foo} and {@code targetB.bar},

0 commit comments

Comments
 (0)