Skip to content

Commit b6d899c

Browse files
raphwraphw
committed
Reintroduce base name resolver in suffixing random strategy and deprecate it to provide binary compatibility.
1 parent 3ea315d commit b6d899c

File tree

2 files changed

+120
-6
lines changed

2 files changed

+120
-6
lines changed

‎byte-buddy-dep/src/main/java/net/bytebuddy/NamingStrategy.java

+116-2
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ class SuffixingRandom extends Suffixing {
346346
* @param suffix The suffix for the generated class.
347347
*/
348348
public SuffixingRandom(String suffix) {
349-
this(suffix, BaseNameResolver.ForUnnamedType.INSTANCE);
349+
this(suffix, Suffixing.BaseNameResolver.ForUnnamedType.INSTANCE);
350350
}
351351

352352
/**
@@ -359,7 +359,7 @@ public SuffixingRandom(String suffix) {
359359
* no prefix is added.
360360
*/
361361
public SuffixingRandom(String suffix, String javaLangPackagePrefix) {
362-
this(suffix, BaseNameResolver.ForUnnamedType.INSTANCE, javaLangPackagePrefix);
362+
this(suffix, Suffixing.BaseNameResolver.ForUnnamedType.INSTANCE, javaLangPackagePrefix);
363363
}
364364

365365
/**
@@ -368,8 +368,21 @@ public SuffixingRandom(String suffix, String javaLangPackagePrefix) {
368368
*
369369
* @param suffix The suffix for the generated class.
370370
* @param baseNameResolver The base name resolver that is queried for locating the base name.
371+
* @deprecated Use {@link SuffixingRandom#SuffixingRandom(String, Suffixing.BaseNameResolver)}.
371372
*/
373+
@Deprecated
372374
public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver) {
375+
this(suffix, (Suffixing.BaseNameResolver) baseNameResolver);
376+
}
377+
378+
/**
379+
* Creates an immutable naming strategy with a given suffix but moves types that subclass types within
380+
* the {@code java.lang} package into Byte Buddy's package namespace.
381+
*
382+
* @param suffix The suffix for the generated class.
383+
* @param baseNameResolver The base name resolver that is queried for locating the base name.
384+
*/
385+
public SuffixingRandom(String suffix, Suffixing.BaseNameResolver baseNameResolver) {
373386
this(suffix, baseNameResolver, BYTE_BUDDY_RENAME_PACKAGE);
374387
}
375388

@@ -382,8 +395,24 @@ public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver) {
382395
* @param javaLangPackagePrefix The fallback namespace for type's that subclass types within the
383396
* {@code java.*} namespace. If The prefix is set to the empty string,
384397
* no prefix is added.
398+
* @deprecated Use {@link SuffixingRandom#SuffixingRandom(String, Suffixing.BaseNameResolver, String)}.
385399
*/
400+
@Deprecated
386401
public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver, String javaLangPackagePrefix) {
402+
this(suffix, (Suffixing.BaseNameResolver) baseNameResolver, javaLangPackagePrefix);
403+
}
404+
405+
/**
406+
* Creates an immutable naming strategy with a given suffix but moves types that subclass types within
407+
* the {@code java.lang} package into a given namespace.
408+
*
409+
* @param suffix The suffix for the generated class.
410+
* @param baseNameResolver The base name resolver that is queried for locating the base name.
411+
* @param javaLangPackagePrefix The fallback namespace for type's that subclass types within the
412+
* {@code java.*} namespace. If The prefix is set to the empty string,
413+
* no prefix is added.
414+
*/
415+
public SuffixingRandom(String suffix, Suffixing.BaseNameResolver baseNameResolver, String javaLangPackagePrefix) {
387416
this(suffix, baseNameResolver, javaLangPackagePrefix, new RandomString());
388417
}
389418

@@ -397,8 +426,25 @@ public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver, String
397426
* {@code java.*} namespace. If The prefix is set to the empty string,
398427
* no prefix is added.
399428
* @param randomString The random string instance to use.
429+
* @deprecated Use {@link SuffixingRandom#SuffixingRandom(String, Suffixing.BaseNameResolver, String, RandomString)}.
400430
*/
431+
@Deprecated
401432
public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver, String javaLangPackagePrefix, RandomString randomString) {
433+
this(suffix, (Suffixing.BaseNameResolver) baseNameResolver, javaLangPackagePrefix, randomString);
434+
}
435+
436+
/**
437+
* Creates an immutable naming strategy with a given suffix but moves types that subclass types within
438+
* the {@code java.lang} package into a given namespace.
439+
*
440+
* @param suffix The suffix for the generated class.
441+
* @param baseNameResolver The base name resolver that is queried for locating the base name.
442+
* @param javaLangPackagePrefix The fallback namespace for type's that subclass types within the
443+
* {@code java.*} namespace. If The prefix is set to the empty string,
444+
* no prefix is added.
445+
* @param randomString The random string instance to use.
446+
*/
447+
public SuffixingRandom(String suffix, Suffixing.BaseNameResolver baseNameResolver, String javaLangPackagePrefix, RandomString randomString) {
402448
super(suffix, baseNameResolver, javaLangPackagePrefix);
403449
this.randomString = randomString;
404450
}
@@ -407,6 +453,74 @@ public SuffixingRandom(String suffix, BaseNameResolver baseNameResolver, String
407453
protected String name(TypeDescription superClass) {
408454
return super.name(superClass) + "$" + randomString.nextString();
409455
}
456+
457+
/**
458+
* A base name resolver is responsible for resolving a name onto which the suffix is appended.
459+
*
460+
* @deprecated Use {@link Suffixing.BaseNameResolver}.
461+
*/
462+
@Deprecated
463+
public interface BaseNameResolver extends Suffixing.BaseNameResolver {
464+
465+
/**
466+
* Uses the unnamed type's super type's name as the resolved name.
467+
*
468+
* @deprecated Use {@link Suffixing.BaseNameResolver.ForUnnamedType}.
469+
*/
470+
@Deprecated
471+
enum ForUnnamedType implements BaseNameResolver {
472+
473+
/**
474+
* The singleton instance.
475+
*/
476+
INSTANCE;
477+
478+
/**
479+
* {@inheritDoc}
480+
*/
481+
public String resolve(TypeDescription typeDescription) {
482+
return typeDescription.getName();
483+
}
484+
}
485+
486+
/**
487+
* Uses a specific type's name as the resolved name.
488+
*
489+
* @deprecated Use {@link Suffixing.BaseNameResolver.ForGivenType}.
490+
*/
491+
@Deprecated
492+
@HashCodeAndEqualsPlugin.Enhance
493+
class ForGivenType extends Suffixing.BaseNameResolver.ForGivenType implements BaseNameResolver {
494+
495+
/**
496+
* Creates a new base name resolver that resolves a using the name of a given type.
497+
*
498+
* @param typeDescription The type description which represents the resolved name.
499+
*/
500+
public ForGivenType(TypeDescription typeDescription) {
501+
super(typeDescription);
502+
}
503+
}
504+
505+
/**
506+
* A base name resolver that simply returns a fixed value.
507+
*
508+
* @deprecated Use {@link Suffixing.BaseNameResolver.ForFixedValue}.
509+
*/
510+
@Deprecated
511+
@HashCodeAndEqualsPlugin.Enhance
512+
class ForFixedValue extends Suffixing.BaseNameResolver.ForFixedValue implements BaseNameResolver {
513+
514+
/**
515+
* Creates a new base name resolver for a fixed name.
516+
*
517+
* @param name The fixed name
518+
*/
519+
public ForFixedValue(String name) {
520+
super(name);
521+
}
522+
}
523+
}
410524
}
411525

412526
/**

‎byte-buddy-dep/src/test/java/net/bytebuddy/NamingStrategyTest.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public class NamingStrategyTest {
2222
public TestRule mockitoRule = new MockitoRule(this);
2323

2424
@Mock
25-
private NamingStrategy.SuffixingRandom.BaseNameResolver baseNameResolver;
25+
private NamingStrategy.Suffixing.BaseNameResolver baseNameResolver;
2626

2727
@Mock
2828
private TypeDescription.Generic typeDescription;
@@ -143,10 +143,10 @@ public void testSuffixingRandomRedefine() throws Exception {
143143

144144
@Test
145145
public void testBaseNameResolvers() throws Exception {
146-
assertThat(new NamingStrategy.SuffixingRandom.BaseNameResolver.ForFixedValue(FOO).resolve(rawTypeDescription), is(FOO));
146+
assertThat(new NamingStrategy.Suffixing.BaseNameResolver.ForFixedValue(FOO).resolve(rawTypeDescription), is(FOO));
147147
when(rawTypeDescription.getName()).thenReturn(FOO);
148-
assertThat(new NamingStrategy.SuffixingRandom.BaseNameResolver.ForGivenType(rawTypeDescription).resolve(rawTypeDescription), is(FOO));
149-
assertThat(NamingStrategy.SuffixingRandom.BaseNameResolver.ForUnnamedType.INSTANCE.resolve(rawTypeDescription), is(FOO));
148+
assertThat(new NamingStrategy.Suffixing.BaseNameResolver.ForGivenType(rawTypeDescription).resolve(rawTypeDescription), is(FOO));
149+
assertThat(NamingStrategy.Suffixing.BaseNameResolver.ForUnnamedType.INSTANCE.resolve(rawTypeDescription), is(FOO));
150150
}
151151

152152
@Test

0 commit comments

Comments
 (0)