Skip to content

Commit cfaaa21

Browse files
committed
Change Javadoc version to 11.0.1
1 parent bab68f9 commit cfaaa21

File tree

10 files changed

+40
-40
lines changed

10 files changed

+40
-40
lines changed

docs/features/customization.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For example, suppose the `Product` entity must follow these business rules:
1414
- `priceAmount` must be greater than or equal to `10`
1515
- `priceAmount` must be less than or equal to `10000`
1616

17-
You can implement these rules using a custom generator by extending [`ObjectGeneratorBase<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/generator/ObjectGeneratorBase.html):
17+
You can implement these rules using a custom generator by extending [`ObjectGeneratorBase<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/generator/ObjectGeneratorBase.html):
1818

1919
<JavaKotlinCodeBlock>
2020
```java
@@ -49,9 +49,9 @@ class ProductGenerator : ObjectGeneratorBase<Product>() {
4949
```
5050
</JavaKotlinCodeBlock>
5151

52-
This custom generator creates a `Product` instance that adheres to the business constraints. It uses [`ResolutionContext`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/ResolutionContext.html) to generate supporting values like `id` and `name`, and applies explicit logic to generate a valid `priceAmount`.
52+
This custom generator creates a `Product` instance that adheres to the business constraints. It uses [`ResolutionContext`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/ResolutionContext.html) to generate supporting values like `id` and `name`, and applies explicit logic to generate a valid `priceAmount`.
5353

54-
You can apply this custom generator using the [`@Customization`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/Customization.html) annotation:
54+
You can apply this custom generator using the [`@Customization`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/Customization.html) annotation:
5555

5656
<JavaKotlinCodeBlock>
5757
```java
@@ -142,7 +142,7 @@ fun testMethod(product: Product, review: Review) {
142142
```
143143
</JavaKotlinCodeBlock>
144144

145-
Alternatively, if you prefer to encapsulate multiple generators into a single reusable configuration, you can extend [`CompositeCustomizer`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/CompositeCustomizer.html):
145+
Alternatively, if you prefer to encapsulate multiple generators into a single reusable configuration, you can extend [`CompositeCustomizer`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/CompositeCustomizer.html):
146146

147147
<JavaKotlinCodeBlock>
148148
```java
@@ -312,7 +312,7 @@ class TestClass {
312312
```
313313
</JavaKotlinCodeBlock>
314314

315-
In this example, we use the [`set`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/dsl/ArgumentCustomizationDsl.html#set(autoparams.customization.dsl.FunctionDelegate)) static method from the [`ArgumentCustomizationDsl`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/dsl/ArgumentCustomizationDsl.html) class to customize the behavior of the `ResolutionContext`. Specifically:
315+
In this example, we use the [`set`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/dsl/ArgumentCustomizationDsl.html#set(autoparams.customization.dsl.FunctionDelegate)) static method from the [`ArgumentCustomizationDsl`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/dsl/ArgumentCustomizationDsl.html) class to customize the behavior of the `ResolutionContext`. Specifically:
316316

317317
- The `product` property in any `Review` instance created by the context will be set to the `product` parameter of the test.
318318
- Likewise, the `rating` property will be set to the `rating` parameter.
@@ -359,7 +359,7 @@ class TestClass {
359359
```
360360
</JavaKotlinCodeBlock>
361361

362-
The [`Factory<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/generator/Factory.html) class provides a convenient way to create customized objects when working with a single type. It avoids managing an explicit resolution context and keeps the test focused on the instances under test.
362+
The [`Factory<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/generator/Factory.html) class provides a convenient way to create customized objects when working with a single type. It avoids managing an explicit resolution context and keeps the test focused on the instances under test.
363363

364364
:::note
365365

@@ -376,7 +376,7 @@ The `set` method relies on the availability of parameter names at runtime. Howev
376376

377377
## Settable Properties
378378

379-
If a class follows the JavaBeans convention—meaning it has a no-arguments constructor and public setter methods—AutoParams can automatically populate its properties using the [`InstancePropertyWriter`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/processor/InstancePropertyWriter.html) customizer.
379+
If a class follows the JavaBeans convention—meaning it has a no-arguments constructor and public setter methods—AutoParams can automatically populate its properties using the [`InstancePropertyWriter`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/processor/InstancePropertyWriter.html) customizer.
380380

381381
Here's a simple example:
382382

docs/features/factory.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { JavaKotlinCodeBlock } from '@site/src/components/JavaKotlinCodeBlock';
77

88
# `Factory<T>` class
99

10-
The [`Factory<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/generator/Factory.html) class is useful when you need to generate multiple instances of the same type. It allows you to create single instances or collections of generated objects on demand.
10+
The [`Factory<T>`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/generator/Factory.html) class is useful when you need to generate multiple instances of the same type. It allows you to create single instances or collections of generated objects on demand.
1111

1212
Here's an example:
1313

@@ -31,4 +31,4 @@ fun testMethod() {
3131
```
3232
</JavaKotlinCodeBlock>
3333

34-
In this example, a `Factory<Product>` is created to produce `Product` instances. The [`get()`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/generator/Factory.html#get()) method creates a single instance, while [`getRange(n)`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/generator/Factory.html#getRange(int,autoparams.customization.Customizer...)) returns a list of `n` instances. This approach is particularly helpful when you need bulk data generation in your tests.
34+
In this example, a `Factory<Product>` is created to produce `Product` instances. The [`get()`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/generator/Factory.html#get()) method creates a single instance, while [`getRange(n)`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/generator/Factory.html#getRange(int,autoparams.customization.Customizer...)) returns a list of `n` instances. This approach is particularly helpful when you need bulk data generation in your tests.

docs/features/freeze-by.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import { JavaKotlinCodeBlock } from '@site/src/components/JavaKotlinCodeBlock';
77

88
# `@FreezeBy` Annotation
99

10-
The [`@FreezeBy`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/FreezeBy.html) annotation enables fine-grained control over value freezing in tests. It allows you to freeze a single value and reuse it across multiple generation targets that match specific conditions, such as type or name. This helps improve test readability and ensures consistency among generated values.
10+
The [`@FreezeBy`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/FreezeBy.html) annotation enables fine-grained control over value freezing in tests. It allows you to freeze a single value and reuse it across multiple generation targets that match specific conditions, such as type or name. This helps improve test readability and ensures consistency among generated values.
1111

1212
## Matching Strategies
1313

1414
AutoParams provides several matching strategies that determine which targets should receive the frozen value during object generation. The following examples illustrate some strategies:
1515

16-
- [`EXACT_TYPE`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/Matching.html#EXACT_TYPE)
16+
- [`EXACT_TYPE`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/Matching.html#EXACT_TYPE)
1717

1818
Reuses the frozen value for all targets with the exact same type.
1919

@@ -72,7 +72,7 @@ AutoParams provides several matching strategies that determine which targets sho
7272

7373
In this example, all `String` targets—including the `String` field inside `StringContainer`—are generated with the same frozen value.
7474

75-
- [`IMPLEMENTED_INTERFACES`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/Matching.html#IMPLEMENTED_INTERFACES)
75+
- [`IMPLEMENTED_INTERFACES`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/Matching.html#IMPLEMENTED_INTERFACES)
7676

7777
Reuses the frozen value for targets whose types are interfaces that the frozen value's type implements.
7878

@@ -116,7 +116,7 @@ AutoParams provides several matching strategies that determine which targets sho
116116

117117
In this example, `String` implements `CharSequence`, so the same value is reused for both `s1` and `chars`. `StringContainer` is not affected because its type is not an interface.
118118

119-
- [`PARAMETER_NAME`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/Matching.html#PARAMETER_NAME)
119+
- [`PARAMETER_NAME`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/Matching.html#PARAMETER_NAME)
120120

121121
Reuses the frozen value for other targets with matching names.
122122

@@ -210,7 +210,7 @@ In this example, the frozen value `s1` is reused for both `s2` (same type) and `
210210

211211
## Shorthand for `EXACT_TYPE`
212212

213-
Using [`@Freeze`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/Freeze.html) is equivalent to `@FreezeBy(EXACT_TYPE)`. It's a convenient shorthand for the most common matching strategy.
213+
Using [`@Freeze`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/Freeze.html) is equivalent to `@FreezeBy(EXACT_TYPE)`. It's a convenient shorthand for the most common matching strategy.
214214

215215
<JavaKotlinCodeBlock>
216216
```java

docs/features/parameterized.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Here are some of the features you can use for parameterized tests.
1313

1414
## `@ValueAutoSource` Annotation
1515

16-
The [`@ValueAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/ValueAutoSource.html)(or `@ValueAutoKotlinSource`) annotation is a simple yet powerful tool for writing parameterized tests with AutoParams.
16+
The [`@ValueAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/ValueAutoSource.html)(or `@ValueAutoKotlinSource`) annotation is a simple yet powerful tool for writing parameterized tests with AutoParams.
1717

1818
<JavaKotlinCodeBlock>
1919
```java
@@ -45,7 +45,7 @@ This feature depends on parameter name availability. See the note in the [One-ti
4545

4646
:::
4747

48-
In this example, the test method is executed twice—once with `"Camera"` and once with `"Candle"` as the value of the `name` parameter. The `factory` parameter is resolved automatically by AutoParams and can be customized using the DSL, as shown with [`freezeArgument`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/customization/dsl/ArgumentCustomizationDsl.html).
48+
In this example, the test method is executed twice—once with `"Camera"` and once with `"Candle"` as the value of the `name` parameter. The `factory` parameter is resolved automatically by AutoParams and can be customized using the DSL, as shown with [`freezeArgument`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/customization/dsl/ArgumentCustomizationDsl.html).
4949

5050
This enables the creation of test objects (`Product` in this case) that are partially controlled (e.g., a fixed name) and partially randomized (e.g., all other properties), striking a balance between specificity and variety.
5151

@@ -64,7 +64,7 @@ The usage of `@ValueAutoSource` is similar to JUnit 5's `@ValueSource`, and it s
6464

6565
## `@CsvAutoSource` Annotation
6666

67-
The [`@CsvAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/CsvAutoSource.html)(or `@CsvAutoKotlinSource`) annotation lets you define repeated test inputs in CSV format, similar to JUnit 5’s @CsvSource. Any parameters not explicitly provided in the CSV rows will be automatically generated by AutoParams.
67+
The [`@CsvAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/CsvAutoSource.html)(or `@CsvAutoKotlinSource`) annotation lets you define repeated test inputs in CSV format, similar to JUnit 5’s @CsvSource. Any parameters not explicitly provided in the CSV rows will be automatically generated by AutoParams.
6868

6969
<JavaKotlinCodeBlock>
7070
```java
@@ -100,7 +100,7 @@ This approach makes it easy to test combinations of fixed and dynamic values in
100100

101101
## `@MethodAutoSource` Annotation
102102

103-
The [`@MethodAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/MethodAutoSource.html)(or `@MethodAutoKotlinSource`) annotation combines the features of JUnit 5’s `@MethodSource` and AutoParams’s `@AutoSource`. You can specify a method that provides test data, and AutoParams will fill in any remaining parameters automatically.
103+
The [`@MethodAutoSource`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/MethodAutoSource.html)(or `@MethodAutoKotlinSource`) annotation combines the features of JUnit 5’s `@MethodSource` and AutoParams’s `@AutoSource`. You can specify a method that provides test data, and AutoParams will fill in any remaining parameters automatically.
104104

105105
<JavaKotlinCodeBlock>
106106
```java
@@ -145,7 +145,7 @@ This setup allows you to blend manually specified values with automatically gene
145145

146146
## `@Repeat` Annotation
147147

148-
The [`@Repeat`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/Repeat.html) annotation allows you to run a test multiple times, generating fresh random values for unspecified parameters on each run.
148+
The [`@Repeat`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/Repeat.html) annotation allows you to run a test multiple times, generating fresh random values for unspecified parameters on each run.
149149

150150
<JavaKotlinCodeBlock>
151151
```java

docs/features/resolution-context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { JavaKotlinCodeBlock } from '@site/src/components/JavaKotlinCodeBlock';
77

88
# `ResolutionContext` class
99

10-
The [`ResolutionContext`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.0/autoparams/ResolutionContext.html) class provides the core mechanism for generating test data. While it is used internally by AutoParams, you can also instantiate and use it directly in your own test code when needed.
10+
The [`ResolutionContext`](https://www.javadoc.io/static/io.github.autoparams/autoparams/11.0.1/autoparams/ResolutionContext.html) class provides the core mechanism for generating test data. While it is used internally by AutoParams, you can also instantiate and use it directly in your own test code when needed.
1111

1212
Here's an example:
1313

0 commit comments

Comments
 (0)