Skip to content

Commit 8f4f795

Browse files
committed
GH-810: updated descriptions
1 parent 25f72df commit 8f4f795

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

vector/src/main/java/org/apache/arrow/vector/complex/impl/ExtensionTypeFactory.java

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
import org.apache.arrow.vector.holders.ExtensionHolder;
2323
import org.apache.arrow.vector.types.pojo.ArrowType.ExtensionType;
2424

25+
/**
26+
* A factory interface that allows configuring writer implementations for specific {@link
27+
* ExtensionTypeVector}, get the vector class for a given {@link ExtensionType}, and get the reader
28+
* implementation for a given {@link ExtensionTypeVector}.
29+
*/
2530
public interface ExtensionTypeFactory {
2631

2732
/**
@@ -33,9 +38,29 @@ public interface ExtensionTypeFactory {
3338
*/
3439
FieldWriter getWriterImpl(ExtensionTypeVector vector);
3540

41+
/**
42+
* Returns the vector class for the given {@link ExtensionType}.
43+
*
44+
* @param extensionType the {@link ExtensionType} for which the vector class is to be returned.
45+
* @return the vector class for the given {@link ExtensionType}.
46+
*/
3647
Class<? extends ExtensionTypeVector> getVectorClass(ExtensionType extensionType);
3748

49+
/**
50+
* Returns an instance of the reader implementation for the given {@link ExtensionTypeVector}.
51+
*
52+
* @param vector the {@link ExtensionTypeVector} for which the reader implementation is to be
53+
* returned.
54+
* @return an instance of the reader implementation for the given {@link ExtensionTypeVector}.
55+
*/
3856
FieldReader getReaderImpl(ExtensionTypeVector vector);
3957

58+
/**
59+
* Returns the {@link ExtensionType} for the given {@link ExtensionHolder}.
60+
*
61+
* @param holder the {@link ExtensionHolder} for which the {@link ExtensionType} is to be
62+
* returned.
63+
* @return the {@link ExtensionType} for the given {@link ExtensionHolder}.
64+
*/
4065
ExtensionType getExtensionTypeByHolder(ExtensionHolder holder);
4166
}

0 commit comments

Comments
 (0)