-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Introduce Converter
in junit-platform-commons
#4219
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
scordio
wants to merge
2
commits into
junit-team:main
Choose a base branch
from
scordio:conversion-service
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
...ommons/src/main/java/org/junit/platform/commons/support/conversion/ConversionContext.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
/* | ||
* Copyright 2015-2025 the original author or authors. | ||
* | ||
* All rights reserved. This program and the accompanying materials are | ||
* made available under the terms of the Eclipse Public License v2.0 which | ||
* accompanies this distribution and is available at | ||
* | ||
* https://www.eclipse.org/legal/epl-v20.html | ||
*/ | ||
|
||
package org.junit.platform.commons.support.conversion; | ||
|
||
import static org.apiguardian.api.API.Status.EXPERIMENTAL; | ||
|
||
import org.apiguardian.api.API; | ||
import org.jspecify.annotations.Nullable; | ||
|
||
/** | ||
* {@code ConversionContext} encapsulates the <em>context</em> in which the | ||
* current conversion is being executed. | ||
* | ||
* <p>{@link Converter Converters} are provided an instance of | ||
* {@code ConversionContext} to perform their work. | ||
* | ||
* @param sourceType | ||
* @param targetType | ||
* @param classLoader | ||
* | ||
* @since 6.0 | ||
* @see Converter | ||
*/ | ||
@API(status = EXPERIMENTAL, since = "6.0") | ||
public record ConversionContext(TypeDescriptor sourceType, TypeDescriptor targetType, ClassLoader classLoader) { | ||
|
||
/** | ||
* | ||
* @param source | ||
* @param targetType | ||
* @param classLoader | ||
*/ | ||
public ConversionContext(@Nullable Object source, TypeDescriptor targetType, ClassLoader classLoader) { | ||
this(TypeDescriptor.forInstance(source), targetType, classLoader); | ||
} | ||
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
...atform-commons/src/main/java/org/junit/platform/commons/support/conversion/Converter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/* | ||
* Copyright 2015-2025 the original author or authors. | ||
* | ||
* All rights reserved. This program and the accompanying materials are | ||
* made available under the terms of the Eclipse Public License v2.0 which | ||
* accompanies this distribution and is available at | ||
* | ||
* https://www.eclipse.org/legal/epl-v20.html | ||
*/ | ||
|
||
package org.junit.platform.commons.support.conversion; | ||
|
||
import static org.apiguardian.api.API.Status.EXPERIMENTAL; | ||
|
||
import org.apiguardian.api.API; | ||
import org.jspecify.annotations.Nullable; | ||
|
||
/** | ||
* {@code Converter} is an abstraction that allows an input object to | ||
* be converted to an instance of a different class. | ||
* | ||
* <p>Implementations are loaded via the {@link java.util.ServiceLoader} and must | ||
* follow the service provider requirements. They should not make any assumptions | ||
* regarding when they are instantiated or how often they are called. Since | ||
* instances may potentially be cached and called from different threads, they | ||
* should be thread-safe. | ||
* | ||
* <p>Extend {@link TypedConverter} if your implementation always converts | ||
* from a given source type into a given target type and does not need access to | ||
* the {@link ClassLoader} to perform the conversion. | ||
* | ||
* @param <S> | ||
* @param <T> | ||
* | ||
* @since 6.0 | ||
* @see ConversionSupport | ||
* @see TypedConverter | ||
*/ | ||
@API(status = EXPERIMENTAL, since = "6.0") | ||
public interface Converter<S, T> { | ||
|
||
/** | ||
* Determine if the supplied conversion context is supported. | ||
* | ||
* @param context the context for the conversion; never {@code null} | ||
* @return {@code true} if the conversion is supported | ||
*/ | ||
boolean canConvert(ConversionContext context); | ||
|
||
/** | ||
* Convert the supplied source object according to the supplied conversion context. | ||
* <p>This method will only be invoked if {@link #canConvert(ConversionContext)} | ||
* returned {@code true} for the same context. | ||
* | ||
* @param source the source object to convert; may be {@code null} | ||
* but only if the target type is a reference type | ||
* @param context the context for the conversion; never {@code null} | ||
* @return the converted object; may be {@code null} but only if the target | ||
* type is a reference type | ||
* @throws ConversionException if an error occurs during the conversion | ||
*/ | ||
@Nullable | ||
T convert(@Nullable S source, ConversionContext context) throws ConversionException; | ||
|
||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.