Skip to content

Commit

Permalink
improve Column javadoc
Browse files Browse the repository at this point in the history
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
  • Loading branch information
otaviojava committed Oct 30, 2022
1 parent 5c54d3e commit 311cbf7
Showing 1 changed file with 9 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,11 @@
import java.util.function.BiFunction;

/**
* A Column Family entity unit, it is a tuple (pair) that consists of a key-value pair,
* where the key is mapped to a value.
* A Column is a tuple (pair) that consists of the name and its respective value.
* A ColumnEntity has one or more Columns.
*/
public interface Column {


/**
* Creates a column instance
*
Expand All @@ -43,11 +42,10 @@ public interface Column {
*/
static <V> Column of(String name, V value) {
return ServiceLoaderProvider.get(ColumnProvider.class,
()-> ServiceLoader.load(ColumnProvider.class))
() -> ServiceLoader.load(ColumnProvider.class))
.apply(name, value);
}


/**
* The column's name
*
Expand All @@ -65,24 +63,24 @@ static <V> Column of(String name, V value) {
/**
* Alias to {@link Value#get(Class)}
*
* @param clazz the clazz
* @param <T> the type
* @param type the type class
* @param <T> the instance type
* @return {@link Value#get(Class)}
* @throws NullPointerException see {@link Value#get(Class)}
* @throws UnsupportedOperationException see {@link Value#get(Class)}
*/
<T> T get(Class<T> clazz);
<T> T get(Class<T> type);

/**
* Alias to {@link Value#get(TypeSupplier)}
*
* @param typeSupplier {@link Value#get(Class)}
* @param <T> {@link Value#get(Class)}
* @param supplier {@link Value#get(Class)}
* @param <T> {@link Value#get(Class)}
* @return {@link Value#get(TypeSupplier)}
* @throws NullPointerException see {@link Value#get(Class)}
* @throws UnsupportedOperationException see {@link Value#get(Class)}
*/
<T> T get(TypeSupplier<T> typeSupplier);
<T> T get(TypeSupplier<T> supplier);

/**
* Alias to {@link Value#get()}
Expand Down

0 comments on commit 311cbf7

Please sign in to comment.