Skip to content

Commit 51ab13d

Browse files
AndreiKingsleyAndreiKingsley
committed
add AccessApiOverload annotation
1 parent e608d7c commit 51ab13d

File tree

6 files changed

+41
-0
lines changed

6 files changed

+41
-0
lines changed

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/all.kt‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import org.jetbrains.kotlinx.dataframe.DataFrame
1010
import org.jetbrains.kotlinx.dataframe.DataRow
1111
import org.jetbrains.kotlinx.dataframe.Predicate
1212
import org.jetbrains.kotlinx.dataframe.RowFilter
13+
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
1314
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
1415
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
1516
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
@@ -299,6 +300,7 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
299300
*
300301
* `df.`[select][DataFrame.select]` { DataSchemaType::columnGroup.`[allCols][KProperty.allCols]`() }`
301302
*/
303+
@AccessApiOverload
302304
public fun KProperty<*>.allCols(): TransformableColumnSet<*> = columnGroup(this).allCols()
303305

304306
/**
@@ -480,20 +482,25 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
480482
/**
481483
* @include [KPropertyAllAfterDocs] {@set [KPropertyAllAfterDocs.Arg] \ \{ myColumn \}}
482484
*/
485+
@AccessApiOverload
483486
public fun <C> KProperty<C>.allColsAfter(column: ColumnSelector<C, *>): ColumnSet<*> =
484487
columnGroup(this).allColsAfter(column)
485488

486489
/** @include [KPropertyAllAfterDocs] {@set [KPropertyAllAfterDocs.Arg] ("pathTo"["myColumn"])} */
490+
@AccessApiOverload
487491
public fun KProperty<*>.allColsAfter(column: ColumnPath): ColumnSet<*> = columnGroup(this).allColsAfter(column)
488492

489493
/** @include [KPropertyAllAfterDocs] {@set [KPropertyAllAfterDocs.Arg] ("myColumn")} */
494+
@AccessApiOverload
490495
public fun KProperty<*>.allColsAfter(column: String): ColumnSet<*> = columnGroup(this).allColsAfter(column)
491496

492497
/** @include [KPropertyAllAfterDocs] {@set [KPropertyAllAfterDocs.Arg] (myColumn)} */
498+
@AccessApiOverload
493499
public fun KProperty<*>.allColsAfter(column: AnyColumnReference): ColumnSet<*> =
494500
columnGroup(this).allColsAfter(column)
495501

496502
/** @include [KPropertyAllAfterDocs] {@set [KPropertyAllAfterDocs.Arg] (Type::myColumn)} */
503+
@AccessApiOverload
497504
public fun KProperty<*>.allColsAfter(column: KProperty<*>): ColumnSet<*> = columnGroup(this).allColsAfter(column)
498505

499506
/**
@@ -696,20 +703,25 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
696703
/**
697704
* @include [KPropertyAllFromDocs] {@set [KPropertyAllFromDocs.Arg] \ \{ myColumn \}}
698705
*/
706+
@AccessApiOverload
699707
public fun <C> KProperty<C>.allColsFrom(column: ColumnSelector<C, *>): ColumnSet<*> =
700708
columnGroup(this).allColsFrom(column)
701709

702710
/** @include [KPropertyAllFromDocs] {@set [KPropertyAllFromDocs.Arg] ("pathTo"["myColumn"])} */
711+
@AccessApiOverload
703712
public fun KProperty<*>.allColsFrom(column: ColumnPath): ColumnSet<*> = columnGroup(this).allColsFrom(column)
704713

705714
/** @include [KPropertyAllFromDocs] {@set [KPropertyAllFromDocs.Arg] ("myColumn")} */
715+
@AccessApiOverload
706716
public fun KProperty<*>.allColsFrom(column: String): ColumnSet<*> = columnGroup(this).allColsFrom(column)
707717

708718
/** @include [KPropertyAllFromDocs] {@set [KPropertyAllFromDocs.Arg] (myColumn)} */
719+
@AccessApiOverload
709720
public fun KProperty<*>.allColsFrom(column: AnyColumnReference): ColumnSet<*> =
710721
columnGroup(this).allColsFrom(column)
711722

712723
/** @include [KPropertyAllFromDocs] {@set [KPropertyAllFromDocs.Arg] (Type::myColumn)} */
724+
@AccessApiOverload
713725
public fun KProperty<*>.allColsFrom(column: KProperty<*>): ColumnSet<*> = columnGroup(this).allColsFrom(column)
714726

715727
/**
@@ -911,20 +923,25 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
911923
/**
912924
* @include [KPropertyAllBeforeDocs] {@set [KPropertyAllBeforeDocs.Arg] \ \{ myColumn \}}
913925
*/
926+
@AccessApiOverload
914927
public fun <C> KProperty<C>.allColsBefore(column: ColumnSelector<C, *>): ColumnSet<*> =
915928
columnGroup(this).allColsBefore(column)
916929

917930
/** @include [KPropertyAllBeforeDocs] {@set [KPropertyAllBeforeDocs.Arg] ("pathTo"["myColumn"])} */
931+
@AccessApiOverload
918932
public fun KProperty<*>.allColsBefore(column: ColumnPath): ColumnSet<*> = columnGroup(this).allColsBefore(column)
919933

920934
/** @include [KPropertyAllBeforeDocs] {@set [KPropertyAllBeforeDocs.Arg] ("myColumn")} */
935+
@AccessApiOverload
921936
public fun KProperty<*>.allColsBefore(column: String): ColumnSet<*> = columnGroup(this).allColsBefore(column)
922937

923938
/** @include [KPropertyAllBeforeDocs] {@set [KPropertyAllBeforeDocs.Arg] (myColumn)} */
939+
@AccessApiOverload
924940
public fun KProperty<*>.allColsBefore(column: AnyColumnReference): ColumnSet<*> =
925941
columnGroup(this).allColsBefore(column)
926942

927943
/** @include [KPropertyAllBeforeDocs] {@set [KPropertyAllBeforeDocs.Arg] (Type::myColumn)} */
944+
@AccessApiOverload
928945
public fun KProperty<*>.allColsBefore(column: KProperty<*>): ColumnSet<*> = columnGroup(this).allColsBefore(column)
929946

930947
/**
@@ -1127,20 +1144,25 @@ public interface AllColumnsSelectionDsl<out _UNUSED> {
11271144
/**
11281145
* @include [KPropertyAllUpToDocs] {@set [KPropertyAllUpToDocs.Arg] \ \{ myColumn \}}
11291146
*/
1147+
@AccessApiOverload
11301148
public fun <C> KProperty<C>.allColsUpTo(column: ColumnSelector<C, *>): ColumnSet<*> =
11311149
columnGroup(this).allColsUpTo(column)
11321150

11331151
/** @include [KPropertyAllUpToDocs] {@set [KPropertyAllUpToDocs.Arg] ("pathTo"["myColumn"])} */
1152+
@AccessApiOverload
11341153
public fun KProperty<*>.allColsUpTo(column: ColumnPath): ColumnSet<*> = columnGroup(this).allColsUpTo(column)
11351154

11361155
/** @include [KPropertyAllUpToDocs] {@set [KPropertyAllUpToDocs.Arg] ("myColumn")} */
1156+
@AccessApiOverload
11371157
public fun KProperty<*>.allColsUpTo(column: String): ColumnSet<*> = columnGroup(this).allColsUpTo(column)
11381158

11391159
/** @include [KPropertyAllUpToDocs] {@set [KPropertyAllUpToDocs.Arg] (myColumn)} */
1160+
@AccessApiOverload
11401161
public fun KProperty<*>.allColsUpTo(column: AnyColumnReference): ColumnSet<*> =
11411162
columnGroup(this).allColsUpTo(column)
11421163

11431164
/** @include [KPropertyAllUpToDocs] {@set [KPropertyAllUpToDocs.Arg] (Type::myColumn)} */
1165+
@AccessApiOverload
11441166
public fun KProperty<*>.allColsUpTo(column: KProperty<*>): ColumnSet<*> = columnGroup(this).allColsUpTo(column)
11451167

11461168
/**

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/col.kt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
1010
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
1111
import org.jetbrains.kotlinx.dataframe.columns.SingleColumn
1212
import org.jetbrains.kotlinx.dataframe.documentation.AccessApiLink
13+
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
1314
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate
1415
import org.jetbrains.kotlinx.dataframe.documentation.Indent
1516
import org.jetbrains.kotlinx.dataframe.documentation.Issues
@@ -186,6 +187,7 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
186187
/**
187188
* @include [ColReferenceDocs] {@set [CommonColDocs.RECEIVER] Type::myColumnGroup.}
188189
*/
190+
@AccessApiOverload
189191
public fun <C> KProperty<*>.col(col: ColumnAccessor<C>): ColumnAccessor<C> =
190192
columnGroup(this).ensureIsColumnGroup().column(col.path())
191193

@@ -278,6 +280,7 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
278280
* @include [ColNameDocs] {@set [CommonColDocs.RECEIVER] Type::myColumnGroup.}
279281
* @include [CommonColDocs.ColumnTypeParam]
280282
*/
283+
@AccessApiOverload
281284
public fun <C> KProperty<*>.col(name: String): ColumnAccessor<C> =
282285
columnGroup(this).ensureIsColumnGroup().column(name)
283286

@@ -377,6 +380,7 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
377380
* @include [ColPathDocs] {@set [CommonColDocs.RECEIVER] Type::myColumnGroup.}
378381
* @include [CommonColDocs.ColumnTypeParam]
379382
*/
383+
@AccessApiOverload
380384
public fun <C> KProperty<*>.col(path: ColumnPath): ColumnAccessor<C> =
381385
columnGroup(this).ensureIsColumnGroup().column(path)
382386

@@ -432,6 +436,7 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
432436
/**
433437
* @include [ColKPropertyDocs] {@set [CommonColDocs.RECEIVER] Type::myColumnGroup.}
434438
*/
439+
@AccessApiOverload
435440
public fun <C> KProperty<*>.col(property: KProperty<C>): ColumnAccessor<C> =
436441
columnGroup(this).ensureIsColumnGroup().column(property)
437442

@@ -531,6 +536,7 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
531536
* @include [ColIndexDocs] {@set [CommonColDocs.RECEIVER] Type::myColumnGroup.}
532537
* @include [CommonColDocs.ColumnTypeParam]
533538
*/
539+
@AccessApiOverload
534540
public fun <C> KProperty<*>.col(index: Int): SingleColumn<C> = columnGroup(this).col<C>(index)
535541

536542
/**

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/colsInGroups.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package org.jetbrains.kotlinx.dataframe.api
22

33
import org.jetbrains.kotlinx.dataframe.ColumnFilter
44
import org.jetbrains.kotlinx.dataframe.DataColumn
5+
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
56
import org.jetbrains.kotlinx.dataframe.DataFrame
67
import org.jetbrains.kotlinx.dataframe.DataRow
78
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
@@ -158,6 +159,7 @@ public interface ColsInGroupsColumnsSelectionDsl {
158159
*
159160
* `df.`[select][DataFrame.select]` { DataSchemaType::myColumnGroup.`[colsInGroups][KProperty.colsInGroups]`() }`
160161
*/
162+
@AccessApiOverload
161163
public fun KProperty<*>.colsInGroups(predicate: ColumnFilter<*> = { true }): TransformableColumnSet<*> =
162164
columnGroup(this).colsInGroups(predicate)
163165

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/columnNameFilters.kt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package org.jetbrains.kotlinx.dataframe.api
33
import org.jetbrains.kotlinx.dataframe.DataColumn
44
import org.jetbrains.kotlinx.dataframe.DataFrame
55
import org.jetbrains.kotlinx.dataframe.DataRow
6+
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
67
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
78
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
89
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
@@ -192,6 +193,7 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
192193
*
193194
* `df.`[select][DataFrame.select]` { DataSchemaType::someGroupCol.`[colsNameContains][KProperty.colsNameContains]`("my") }`
194195
*/
196+
@AccessApiOverload
195197
public fun KProperty<*>.colsNameContains(
196198
text: CharSequence,
197199
ignoreCase: Boolean = false,
@@ -258,6 +260,7 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
258260
*
259261
* `df.`[select][DataFrame.select]` { DataSchemaType::someGroupCol.`[colsNameContains][KProperty.colsNameContains]`(`[Regex][Regex]`("order-[0-9]+")) }`
260262
*/
263+
@AccessApiOverload
261264
public fun KProperty<*>.colsNameContains(regex: Regex): TransformableColumnSet<*> =
262265
columnGroup(this).colsNameContains(regex)
263266

@@ -399,6 +402,7 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
399402
*
400403
* `df.`[select][DataFrame.select]` { DataSchemaType::someGroupCol.`[colsNameStartsWith][KProperty.colsNameStartsWith]`("order-") }`
401404
*/
405+
@AccessApiOverload
402406
public fun KProperty<*>.colsNameStartsWith(
403407
prefix: CharSequence,
404408
ignoreCase: Boolean = false,
@@ -486,6 +490,7 @@ public interface ColumnNameFiltersColumnsSelectionDsl {
486490
*
487491
* `df.`[select][DataFrame.select]` { DataSchemaType::someGroupCol.`[colsNameEndsWith][KProperty.colsNameEndsWith]`("-order") }`
488492
*/
493+
@AccessApiOverload
489494
public fun KProperty<*>.colsNameEndsWith(
490495
suffix: CharSequence,
491496
ignoreCase: Boolean = false,

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/drop.kt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import org.jetbrains.kotlinx.dataframe.DataFrame
66
import org.jetbrains.kotlinx.dataframe.DataRow
77
import org.jetbrains.kotlinx.dataframe.Predicate
88
import org.jetbrains.kotlinx.dataframe.RowFilter
9+
import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
910
import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
1011
import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
1112
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
@@ -161,6 +162,7 @@ public interface DropColumnsSelectionDsl {
161162
*
162163
* `df.`[select][DataFrame.select]` { DataSchemaType::myColumnGroup.`[dropCols][KProperty.dropCols]`(1) }`
163164
*/
165+
@AccessApiOverload
164166
public fun KProperty<*>.dropCols(n: Int): ColumnSet<*> = columnGroup(this).dropCols(n)
165167

166168
/**
@@ -228,6 +230,7 @@ public interface DropColumnsSelectionDsl {
228230
*
229231
* `df.`[select][DataFrame.select]` { DataSchemaType::myColumnGroup.`[dropLastCols][KProperty.dropLastCols]`(1) }`
230232
*/
233+
@AccessApiOverload
231234
public fun KProperty<*>.dropLastCols(n: Int): ColumnSet<*> = columnGroup(this).dropLastCols(n)
232235

233236
/**
@@ -295,6 +298,7 @@ public interface DropColumnsSelectionDsl {
295298
*
296299
* `df.`[select][DataFrame.select]` { DataSchemaType::myColumnGroup.`[dropColsWhile][KProperty.dropColsWhile]` { it.`[any][ColumnWithPath.any]` { it == "Alice" } } }`
297300
*/
301+
@AccessApiOverload
298302
public fun KProperty<*>.dropColsWhile(predicate: ColumnFilter<*>): ColumnSet<*> =
299303
columnGroup(this).dropColsWhile(predicate)
300304

@@ -366,6 +370,7 @@ public interface DropColumnsSelectionDsl {
366370
*
367371
* `df.`[select][DataFrame.select]` { DataSchemaType::myColumnGroup.`[dropLastColsWhile][KProperty.dropLastColsWhile]` { it.`[any][ColumnWithPath.any]` { it == "Alice" } } }`
368372
*/
373+
@AccessApiOverload
369374
public fun KProperty<*>.dropLastColsWhile(predicate: ColumnFilter<*>): ColumnSet<*> =
370375
columnGroup(this).dropLastColsWhile(predicate)
371376

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/move.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ public fun <T> DataFrame<T>.moveTo(newColumnIndex: Int, columns: ColumnsSelector
206206
public fun <T> DataFrame<T>.moveTo(newColumnIndex: Int, vararg columns: String): DataFrame<T> =
207207
moveTo(newColumnIndex) { columns.toColumnSet() }
208208

209+
@AccessApiOverload
209210
public fun <T> DataFrame<T>.moveTo(newColumnIndex: Int, vararg columns: AnyColumnReference): DataFrame<T> =
210211
moveTo(newColumnIndex) { columns.toColumnSet() }
211212

0 commit comments

Comments
 (0)