Skip to content

Commit 78ab98c

Browse files
tom-andersentom-andersen
committed
Response to PR review (and back porting from evaluation)
1 parent ac26746 commit 78ab98c

File tree

7 files changed

+147
-247
lines changed

7 files changed

+147
-247
lines changed

‎firebase-firestore/api.txt

Lines changed: 27 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ package com.google.firebase.firestore {
440440
method public com.google.firebase.firestore.Pipeline replace(com.google.firebase.firestore.pipeline.Expr mapValue);
441441
method public com.google.firebase.firestore.Pipeline replace(String field);
442442
method public com.google.firebase.firestore.Pipeline sample(com.google.firebase.firestore.pipeline.SampleStage sample);
443-
method public com.google.firebase.firestore.Pipeline sample(int documents);
443+
method public com.google.firebase.firestore.Pipeline sample(int count);
444444
method public com.google.firebase.firestore.Pipeline select(com.google.firebase.firestore.pipeline.Selectable selection, java.lang.Object... additionalSelections);
445445
method public com.google.firebase.firestore.Pipeline select(String fieldName, java.lang.Object... additionalSelections);
446446
method public com.google.firebase.firestore.Pipeline sort(com.google.firebase.firestore.pipeline.Ordering order, com.google.firebase.firestore.pipeline.Ordering... additionalOrders);
@@ -680,8 +680,8 @@ package com.google.firebase.firestore.pipeline {
680680
public abstract class AbstractOptions<T extends com.google.firebase.firestore.pipeline.AbstractOptions<T>> {
681681
method public final T with(String key, boolean value);
682682
method public final T with(String key, com.google.firebase.firestore.pipeline.Field value);
683-
method public final T with(String key, com.google.firebase.firestore.pipeline.GenericOptions value);
684683
method protected final T with(String key, com.google.firebase.firestore.pipeline.InternalOptions value);
684+
method public final T with(String key, com.google.firebase.firestore.pipeline.RawOptions value);
685685
method public final T with(String key, double value);
686686
method protected final T with(String key, error.NonExistentClass value);
687687
method public final T with(String key, String value);
@@ -696,11 +696,11 @@ package com.google.firebase.firestore.pipeline {
696696
method public static com.google.firebase.firestore.pipeline.AggregateFunction count(String fieldName);
697697
method public static com.google.firebase.firestore.pipeline.AggregateFunction countAll();
698698
method public static com.google.firebase.firestore.pipeline.AggregateFunction countIf(com.google.firebase.firestore.pipeline.BooleanExpr condition);
699-
method public static com.google.firebase.firestore.pipeline.AggregateFunction generic(String name, com.google.firebase.firestore.pipeline.Expr... expr);
700699
method public static com.google.firebase.firestore.pipeline.AggregateFunction maximum(com.google.firebase.firestore.pipeline.Expr expression);
701700
method public static com.google.firebase.firestore.pipeline.AggregateFunction maximum(String fieldName);
702701
method public static com.google.firebase.firestore.pipeline.AggregateFunction minimum(com.google.firebase.firestore.pipeline.Expr expression);
703702
method public static com.google.firebase.firestore.pipeline.AggregateFunction minimum(String fieldName);
703+
method public static com.google.firebase.firestore.pipeline.AggregateFunction raw(String name, com.google.firebase.firestore.pipeline.Expr... expr);
704704
method public static com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expression);
705705
method public static com.google.firebase.firestore.pipeline.AggregateFunction sum(String fieldName);
706706
field public static final com.google.firebase.firestore.pipeline.AggregateFunction.Companion Companion;
@@ -713,11 +713,11 @@ package com.google.firebase.firestore.pipeline {
713713
method public com.google.firebase.firestore.pipeline.AggregateFunction count(String fieldName);
714714
method public com.google.firebase.firestore.pipeline.AggregateFunction countAll();
715715
method public com.google.firebase.firestore.pipeline.AggregateFunction countIf(com.google.firebase.firestore.pipeline.BooleanExpr condition);
716-
method public com.google.firebase.firestore.pipeline.AggregateFunction generic(String name, com.google.firebase.firestore.pipeline.Expr... expr);
717716
method public com.google.firebase.firestore.pipeline.AggregateFunction maximum(com.google.firebase.firestore.pipeline.Expr expression);
718717
method public com.google.firebase.firestore.pipeline.AggregateFunction maximum(String fieldName);
719718
method public com.google.firebase.firestore.pipeline.AggregateFunction minimum(com.google.firebase.firestore.pipeline.Expr expression);
720719
method public com.google.firebase.firestore.pipeline.AggregateFunction minimum(String fieldName);
720+
method public com.google.firebase.firestore.pipeline.AggregateFunction raw(String name, com.google.firebase.firestore.pipeline.Expr... expr);
721721
method public com.google.firebase.firestore.pipeline.AggregateFunction sum(com.google.firebase.firestore.pipeline.Expr expression);
722722
method public com.google.firebase.firestore.pipeline.AggregateFunction sum(String fieldName);
723723
}
@@ -772,59 +772,6 @@ package com.google.firebase.firestore.pipeline {
772772
method public com.google.firebase.firestore.pipeline.CollectionSource of(String path);
773773
}
774774

775-
public final class ExplainOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.ExplainOptions> {
776-
method public error.NonExistentClass withIndexRecommendation(boolean value);
777-
method public error.NonExistentClass withMode(com.google.firebase.firestore.pipeline.ExplainOptions.ExplainMode value);
778-
method public error.NonExistentClass withOutputFormat(com.google.firebase.firestore.pipeline.ExplainOptions.OutputFormat value);
779-
method public error.NonExistentClass withProfiles(com.google.firebase.firestore.pipeline.ExplainOptions.Profiles value);
780-
method public error.NonExistentClass withRedact(boolean value);
781-
method public error.NonExistentClass withVerbosity(com.google.firebase.firestore.pipeline.ExplainOptions.Verbosity value);
782-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Companion Companion;
783-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions DEFAULT;
784-
}
785-
786-
public static final class ExplainOptions.Companion {
787-
}
788-
789-
public static final class ExplainOptions.ExplainMode {
790-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.ExplainMode ANALYZE;
791-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.ExplainMode.Companion Companion;
792-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.ExplainMode EXECUTE;
793-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.ExplainMode EXPLAIN;
794-
}
795-
796-
public static final class ExplainOptions.ExplainMode.Companion {
797-
}
798-
799-
public static final class ExplainOptions.OutputFormat {
800-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.OutputFormat.Companion Companion;
801-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.OutputFormat JSON;
802-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.OutputFormat STRUCT;
803-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.OutputFormat TEXT;
804-
}
805-
806-
public static final class ExplainOptions.OutputFormat.Companion {
807-
}
808-
809-
public static final class ExplainOptions.Profiles {
810-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Profiles BYTES_THROUGHPUT;
811-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Profiles.Companion Companion;
812-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Profiles LATENCY;
813-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Profiles RECORDS_COUNT;
814-
}
815-
816-
public static final class ExplainOptions.Profiles.Companion {
817-
}
818-
819-
public static final class ExplainOptions.Verbosity {
820-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Verbosity.Companion Companion;
821-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Verbosity EXECUTION_TREE;
822-
field public static final com.google.firebase.firestore.pipeline.ExplainOptions.Verbosity SUMMARY_ONLY;
823-
}
824-
825-
public static final class ExplainOptions.Verbosity.Companion {
826-
}
827-
828775
public abstract class Expr {
829776
method public final com.google.firebase.firestore.pipeline.Expr add(com.google.firebase.firestore.pipeline.Expr second);
830777
method public static final com.google.firebase.firestore.pipeline.Expr add(com.google.firebase.firestore.pipeline.Expr first, com.google.firebase.firestore.pipeline.Expr second);
@@ -1056,6 +1003,7 @@ package com.google.firebase.firestore.pipeline {
10561003
method public static final com.google.firebase.firestore.pipeline.BooleanExpr lte(String fieldName, com.google.firebase.firestore.pipeline.Expr expression);
10571004
method public static final com.google.firebase.firestore.pipeline.BooleanExpr lte(String fieldName, Object value);
10581005
method public static final com.google.firebase.firestore.pipeline.Expr map(java.util.Map<java.lang.String,?> elements);
1006+
method public final com.google.firebase.firestore.pipeline.Expr mapGet(com.google.firebase.firestore.pipeline.Expr keyExpression);
10591007
method public static final com.google.firebase.firestore.pipeline.Expr mapGet(com.google.firebase.firestore.pipeline.Expr mapExpression, com.google.firebase.firestore.pipeline.Expr keyExpression);
10601008
method public static final com.google.firebase.firestore.pipeline.Expr mapGet(com.google.firebase.firestore.pipeline.Expr mapExpression, String key);
10611009
method public final com.google.firebase.firestore.pipeline.Expr mapGet(String key);
@@ -1064,7 +1012,7 @@ package com.google.firebase.firestore.pipeline {
10641012
method public static final com.google.firebase.firestore.pipeline.Expr mapMerge(com.google.firebase.firestore.pipeline.Expr firstMap, com.google.firebase.firestore.pipeline.Expr secondMap, com.google.firebase.firestore.pipeline.Expr... otherMaps);
10651013
method public final com.google.firebase.firestore.pipeline.Expr mapMerge(com.google.firebase.firestore.pipeline.Expr mapExpr, com.google.firebase.firestore.pipeline.Expr... otherMaps);
10661014
method public static final com.google.firebase.firestore.pipeline.Expr mapMerge(String firstMapFieldName, com.google.firebase.firestore.pipeline.Expr secondMap, com.google.firebase.firestore.pipeline.Expr... otherMaps);
1067-
method public final com.google.firebase.firestore.pipeline.Expr mapRemove(com.google.firebase.firestore.pipeline.Expr key);
1015+
method public final com.google.firebase.firestore.pipeline.Expr mapRemove(com.google.firebase.firestore.pipeline.Expr keyExpression);
10681016
method public static final com.google.firebase.firestore.pipeline.Expr mapRemove(com.google.firebase.firestore.pipeline.Expr mapExpr, com.google.firebase.firestore.pipeline.Expr key);
10691017
method public static final com.google.firebase.firestore.pipeline.Expr mapRemove(com.google.firebase.firestore.pipeline.Expr mapExpr, String key);
10701018
method public final com.google.firebase.firestore.pipeline.Expr mapRemove(String key);
@@ -1485,6 +1433,10 @@ package com.google.firebase.firestore.pipeline {
14851433
}
14861434

14871435
public final class ExprWithAlias extends com.google.firebase.firestore.pipeline.Selectable {
1436+
method public String getAlias();
1437+
method public com.google.firebase.firestore.pipeline.Expr getExpr();
1438+
property public String alias;
1439+
property public com.google.firebase.firestore.pipeline.Expr expr;
14881440
}
14891441

14901442
public final class Field extends com.google.firebase.firestore.pipeline.Selectable {
@@ -1526,14 +1478,6 @@ package com.google.firebase.firestore.pipeline {
15261478
public class FunctionExpr extends com.google.firebase.firestore.pipeline.Expr {
15271479
}
15281480

1529-
public final class GenericOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.GenericOptions> {
1530-
field public static final com.google.firebase.firestore.pipeline.GenericOptions.Companion Companion;
1531-
field public static final com.google.firebase.firestore.pipeline.GenericOptions DEFAULT;
1532-
}
1533-
1534-
public static final class GenericOptions.Companion {
1535-
}
1536-
15371481
public final class InternalOptions {
15381482
field public static final com.google.firebase.firestore.pipeline.InternalOptions.Companion Companion;
15391483
field public static final com.google.firebase.firestore.pipeline.InternalOptions EMPTY;
@@ -1562,7 +1506,6 @@ package com.google.firebase.firestore.pipeline {
15621506
}
15631507

15641508
public final class PipelineOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.PipelineOptions> {
1565-
method public com.google.firebase.firestore.pipeline.PipelineOptions withExplainOptions(com.google.firebase.firestore.pipeline.ExplainOptions options);
15661509
method public com.google.firebase.firestore.pipeline.PipelineOptions withIndexMode(com.google.firebase.firestore.pipeline.PipelineOptions.IndexMode indexMode);
15671510
field public static final com.google.firebase.firestore.pipeline.PipelineOptions.Companion Companion;
15681511
field public static final com.google.firebase.firestore.pipeline.PipelineOptions DEFAULT;
@@ -1579,6 +1522,14 @@ package com.google.firebase.firestore.pipeline {
15791522
public static final class PipelineOptions.IndexMode.Companion {
15801523
}
15811524

1525+
public final class RawOptions extends com.google.firebase.firestore.pipeline.AbstractOptions<com.google.firebase.firestore.pipeline.RawOptions> {
1526+
field public static final com.google.firebase.firestore.pipeline.RawOptions.Companion Companion;
1527+
field public static final com.google.firebase.firestore.pipeline.RawOptions DEFAULT;
1528+
}
1529+
1530+
public static final class RawOptions.Companion {
1531+
}
1532+
15821533
public final class RawStage extends com.google.firebase.firestore.pipeline.Stage<com.google.firebase.firestore.pipeline.RawStage> {
15831534
method public static com.google.firebase.firestore.pipeline.RawStage ofName(String name);
15841535
method public com.google.firebase.firestore.pipeline.RawStage withArguments(java.lang.Object... arguments);
@@ -1590,13 +1541,13 @@ package com.google.firebase.firestore.pipeline {
15901541
}
15911542

15921543
public final class SampleStage extends com.google.firebase.firestore.pipeline.Stage<com.google.firebase.firestore.pipeline.SampleStage> {
1593-
method public static com.google.firebase.firestore.pipeline.SampleStage withDocLimit(int documents);
1544+
method public static com.google.firebase.firestore.pipeline.SampleStage withCount(int count);
15941545
method public static com.google.firebase.firestore.pipeline.SampleStage withPercentage(double percentage);
15951546
field public static final com.google.firebase.firestore.pipeline.SampleStage.Companion Companion;
15961547
}
15971548

15981549
public static final class SampleStage.Companion {
1599-
method public com.google.firebase.firestore.pipeline.SampleStage withDocLimit(int documents);
1550+
method public com.google.firebase.firestore.pipeline.SampleStage withCount(int count);
16001551
method public com.google.firebase.firestore.pipeline.SampleStage withPercentage(double percentage);
16011552
}
16021553

@@ -1615,14 +1566,14 @@ package com.google.firebase.firestore.pipeline {
16151566
ctor public Selectable();
16161567
}
16171568

1618-
public abstract class Stage<T extends com.google.firebase.firestore.pipeline.Stage<T>> {
1569+
public abstract sealed class Stage<T extends com.google.firebase.firestore.pipeline.Stage<T>> {
16191570
method protected final String getName();
1620-
method public final T with(String key, boolean value);
1621-
method public final T with(String key, com.google.firebase.firestore.pipeline.Field value);
1622-
method public final T with(String key, double value);
1623-
method protected final T with(String key, error.NonExistentClass value);
1624-
method public final T with(String key, String value);
1625-
method public final T with(String key, long value);
1571+
method public final T withOption(String key, boolean value);
1572+
method public final T withOption(String key, com.google.firebase.firestore.pipeline.Field value);
1573+
method public final T withOption(String key, double value);
1574+
method protected final T withOption(String key, error.NonExistentClass value);
1575+
method public final T withOption(String key, String value);
1576+
method public final T withOption(String key, long value);
16261577
property protected final String name;
16271578
}
16281579

0 commit comments

Comments
 (0)