Skip to content

Commit 994f99c

Browse files
apollo-deapollo-de
andauthored
Adjust malefirstName to align with its female counterpart, and java naming conventions - maleFirstName (#1519)
* datafaker-1518: added maleFirstName method and deprecated the ill-named malefirstName. * datafaker-1518: added documentation for deprecation --------- Co-authored-by: apollo-de <anonnymous@anonymous.com>
1 parent 8f2b819 commit 994f99c

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

src/main/java/net/datafaker/providers/base/Name.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,21 @@ public String femaleFirstName() {
7272

7373
/**
7474
* Returns a random male 'given' name.
75+
* @deprecated Use {@link #maleFirstName()} instead.
7576
*
7677
* @return a male 'given' name
7778
*/
79+
@Deprecated(since = "2.4.3", forRemoval = true)
7880
public String malefirstName() {
81+
return maleFirstName();
82+
}
83+
84+
/**
85+
* Returns a random male 'given' name.
86+
*
87+
* @return a male 'given' name
88+
*/
89+
public String maleFirstName() {
7990
return resolve("name.male_first_name");
8091
}
8192

src/test/java/net/datafaker/providers/base/NameTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ void testFemaleFirstName() {
6464

6565
@RepeatedTest(10)
6666
void testMaleFirstName() {
67-
assertThat(name.malefirstName()).matches("\\w+");
67+
assertThat(name.maleFirstName()).matches("\\w+");
6868
}
6969

7070
@Test
@@ -131,7 +131,7 @@ void testFemaleFirstName() {
131131

132132
@RepeatedTest(10)
133133
void testMaleFirstName() {
134-
assertThat(name.malefirstName()).matches("\\p{L}+");
134+
assertThat(name.maleFirstName()).matches("\\p{L}+");
135135
}
136136

137137
@Test

0 commit comments

Comments
 (0)