Skip to content
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

Fix project's Javadocs #18

Merged
merged 2 commits into from
Jul 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ public Map<String, Class<?>> defineGCClasses(@NonNull final Map<String, byte[]>
* @param ctClass javassist's compile-time class
* @return defined class
*
* @throws IOException if an Input/Output problem occurs while defining a class
* @throws CannotCompileException if one of the compile-time classes cannot be compiled
*
* @see #defineGCClass(String, byte[])
* @see #defineGCClasses(Map)
* @see #defineGCClasses(CtClass...)
Expand All @@ -106,6 +109,9 @@ public Class<?> defineGCClass(@NonNull final CtClass ctClass)
* @param classes javassist's compile-time classes
* @return defined classes in the order their data was passed
*
* @throws IOException if an Input/Output problem occurs while defining a class
* @throws CannotCompileException if one of the compile-time classes cannot be compiled
*
* @see #defineGCClass(String, byte[])
* @see #defineGCClasses(CtClass...)
* @see #defineGCClasses(Map)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import java.util.Objects;

/**
* A wrapper for {@link Iterator<E>} to make it treated as a {@link Collection<E>}.
* A wrapper for {@link Iterator} to make it treated as a {@link Collection}.
* It provides lazy access to its entries so that iteration happens only when needed.
*
* @param <E> type of element stored
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
* @param <T> type of wrapped value
*/
@RequiredArgsConstructor
@FieldDefaults(level = AccessLevel.PROTECTED, makeFinal = true)
@FieldDefaults(level = AccessLevel.PROTECTED)
public class ConcurrentWrapper<T> {

@NonNull final T wrapped;
@NonNull T wrapped;

ReadWriteLock lock = new ReentrantReadWriteLock();
Lock readLock = lock.readLock();
Expand All @@ -30,7 +30,7 @@ public class ConcurrentWrapper<T> {
*
* @implNote this method is not concurrent because if modification happens
* then the result of its call is anyway irrelevant
* @implNote simply calls to {@link #wrapped}'s {@link T#equals(Object)} method
* @implNote simply calls to {@link #wrapped}'s {@link Object#equals(Object)} method
* as it provides mostly symmetric logic
*/
@Override
Expand All @@ -44,7 +44,7 @@ public boolean equals(final Object obj) {
*
* @implNote this method is not concurrent because if modification happens
* then the result of its call is anyway irrelevant
* @implNote simply calls to {@link #wrapped}'s {@link T#hashCode()} method
* @implNote simply calls to {@link #wrapped}'s {@link Object#hashCode()} method
* as it provides a logically unique value
*/
@Override
Expand All @@ -54,7 +54,7 @@ public int hashCode() {

/**
* {@inheritDoc}
* @implNote simply adds <i>Concurrent</i> prefix to {@link #wrapped} {@link T#toString()} call result
* @implNote simply adds <i>Concurrent</i> prefix to {@link #wrapped} {@link Object#toString()} call result
*/
@Override
public String toString() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* A value which may be present (which includes {@code null}) or not-present.
* <p>
* This differs from {@link java.util.Optional<T>} as presence of a {@code null} value
* This differs from {@link java.util.Optional} as presence of a {@code null} value
* does not make this value container empty.
*
* @param <T> type of stored value
Expand Down Expand Up @@ -58,6 +58,7 @@ static <T> ValueContainer<T> ofNull() {
/**
* Gets a non-empty value container containing the specified value.
*
* @param value nullable value stored in the container
* @param <T> type of stored value
* @return non-empty value container containing the specified value
*/
Expand All @@ -69,6 +70,7 @@ static <T> ValueContainer<T> of(@Nullable final T value) {
/**
* Gets a value container containing the specified value or an empty one if the values is {@code null}.
*
* @param value value stored in the container
* @param <T> type of stored value
* @return non-empty value container containing the specified value
* if it is not {@code null} and an empty one otherwise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ static boolean classExists(@NonNull final String className) {
* This strategy will append numeric IDs to the given base name.
*
* @param baseName base name of the generated class names to which the ID should be appended
*
* @return created paginated class naming strategy
*/
static PaginatedClassNamingStrategy createPaginated(@NonNull final String baseName) {
return new PaginatedClassNamingStrategy(baseName);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ public interface ThrowingBiFunction<T, U, R, X extends Throwable> extends BiFunc
*
* @param t the first function argument
* @param u the second function argument
* @return the function result
* @throws X if an exception happens
*
*/
R invoke(T t, U u) throws X;

Expand Down
18 changes: 17 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,23 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<doclint>none</doclint>
<tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API note</head>
</tag>
<tag>
<name>implNote</name>
<placement>a</placement>
<head>Implementation note</head>
</tag>
<tag>
<name>implSpec</name>
<placement>a</placement>
<head>Implementation specification</head>
</tag>
</tags>
</configuration>
</plugin>
</plugins>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,7 @@ public <T, V> BiConsumer<T, V> toSetterBiConsumer(@NonNull final Field field) {
*
* @param <F> type of functional interface implemented
* @param <T> type of target value
* @return created invoke factory
*/
public <F, T> InvokeFactory<F, T> invokeFactory() {
return SimpleInvokeFactory
Expand Down