Skip to content

Commit c4a542e

Browse files
committed
Add deprecation to all subclass methods as well
1 parent 12c1b58 commit c4a542e

17 files changed

Lines changed: 137 additions & 1 deletion

src/main/java/com/laytonsmith/core/constructs/CArray.java

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ private static Mixed[] getArray(Collection<Mixed> items) {
182182
return c;
183183
}
184184

185+
/** @deprecated Use {@link #asList(Environment)} instead. */
185186
@Deprecated
186187
public List<Mixed> asList() {
187188
return asList(null);
@@ -229,6 +230,7 @@ public static CArray GetAssociativeArray(Target t) {
229230
return GetAssociativeArray(t, null, null);
230231
}
231232

233+
/** @deprecated Use {@link #GetAssociativeArray(Target, GenericParameters, Environment, Mixed[])} instead. */
232234
@Deprecated
233235
public static CArray GetAssociativeArray(Target t, Mixed[] args) {
234236
return GetAssociativeArray(t, null, null, args);
@@ -286,6 +288,7 @@ public void reverse(Target t) {
286288
}
287289
}
288290

291+
/** @deprecated Use {@link #push(Mixed, Target, Environment)} instead. */
289292
@Deprecated
290293
public final void push(Mixed c, Target t) {
291294
push(c, t, null);
@@ -306,6 +309,7 @@ public final void push(String s) {
306309
push(new CString(s, Target.UNKNOWN), Target.UNKNOWN);
307310
}
308311

312+
/** @deprecated Use {@link #push(Mixed, Integer, Target, Environment)} instead. */
309313
@Deprecated
310314
public void push(Mixed c, Integer index, Target t) throws IllegalArgumentException, IndexOutOfBoundsException {
311315
push(c, index, t, null);
@@ -356,6 +360,8 @@ public void push(Mixed c, Integer index, Target t, Environment env) throws Illeg
356360
setDirty();
357361
}
358362

363+
/** @deprecated Use {@link #keySet(Environment)} instead. */
364+
@Deprecated
359365
@Override
360366
public Set<Mixed> keySet() {
361367
return keySet(null);
@@ -412,6 +418,7 @@ private void setAssociative() {
412418
array = null; // null out the original array container so it can be GC'd
413419
}
414420

421+
/** @deprecated Use {@link #set(Mixed, Mixed, Target, Environment)} instead. */
415422
@Deprecated
416423
public void set(Mixed index, Mixed c, Target t) {
417424
set(index, c, t, null);
@@ -457,6 +464,7 @@ public void set(Mixed index, Mixed c, Target t, Environment env) {
457464
setDirty();
458465
}
459466

467+
/** @deprecated Use {@link #set(int, Mixed, Target, Environment)} instead. */
460468
@Deprecated
461469
public final void set(int index, Mixed c, Target t) {
462470
this.set(index, c, t, null);
@@ -467,6 +475,7 @@ public final void set(int index, Mixed c, Target t, Environment env) {
467475
}
468476

469477
/* Shortcuts */
478+
/** @deprecated Use {@link #set(String, Mixed, Target, Environment)} instead. */
470479
@Deprecated
471480
public final void set(String index, Mixed c, Target t) {
472481
set(index, c, t, null);
@@ -476,6 +485,7 @@ public final void set(String index, Mixed c, Target t, Environment env) {
476485
set(new CString(index, t), c, t, env);
477486
}
478487

488+
/** @deprecated Use {@link #set(String, String, Target, Environment)} instead. */
479489
@Deprecated
480490
public final void set(String index, String value, Target t) {
481491
set(index, value, t, null);
@@ -485,6 +495,7 @@ public final void set(String index, String value, Target t, Environment env) {
485495
set(index, new CString(value, t), t, env);
486496
}
487497

498+
/** @deprecated Use {@link #set(String, String, Environment)} instead. */
488499
@Deprecated
489500
public final void set(String index, String value) {
490501
set(index, value, (Environment) null);
@@ -502,6 +513,8 @@ public final void set(String index, long value) {
502513
set(index, new CInt(value, Target.UNKNOWN), Target.UNKNOWN);
503514
}
504515

516+
/** @deprecated Use {@link #get(Mixed, Target, Environment)} instead. */
517+
@Deprecated
505518
@Override
506519
public Mixed get(Mixed index, Target t) {
507520
return get(index, t, null);
@@ -535,6 +548,8 @@ public final Mixed get(long index, Target t) {
535548
return this.get(new CInt(index, t), t);
536549
}
537550

551+
/** @deprecated Use {@link #get(int, Target, Environment)} instead. */
552+
@Deprecated
538553
@Override
539554
public final Mixed get(int index, Target t) {
540555
return this.get(new CInt(index, t), t);
@@ -545,6 +560,8 @@ public final Mixed get(int index, Target t, Environment env) {
545560
return this.get(new CInt(index, t), t, env);
546561
}
547562

563+
/** @deprecated Use {@link #get(String, Target, Environment)} instead. */
564+
@Deprecated
548565
@Override
549566
public final Mixed get(String index, Target t) {
550567
return this.get(new CString(index, t), t);
@@ -587,6 +604,7 @@ public final boolean contains(int i) {
587604
return contains(new CString(Integer.toString(i), Target.UNKNOWN));
588605
}
589606

607+
/** @deprecated Use {@link #indexesOf(Mixed, Environment)} instead. */
590608
@Deprecated
591609
public CArray indexesOf(Mixed value) {
592610
return indexesOf(value, null);
@@ -697,6 +715,8 @@ protected String getString(Stack<CArray> arrays, Target t) {
697715
return mutVal;
698716
}
699717

718+
/** @deprecated Use {@link #size(Environment)} instead. */
719+
@Deprecated
700720
@Override
701721
public long size() {
702722
return size(null);
@@ -731,6 +751,7 @@ public CArray clone() {
731751
return clone;
732752
}
733753

754+
/** @deprecated Use {@link #deepClone(Target, Environment)} instead. */
734755
@Deprecated
735756
public CArray deepClone(Target t) {
736757
return deepClone(t, null);
@@ -740,6 +761,7 @@ public CArray deepClone(Target t, Environment env) {
740761
return deepClone(this, t, new ArrayList<>(), env);
741762
}
742763

764+
/** @deprecated Use {@link #deepClone(CArray, Target, ArrayList, Environment)} instead. */
743765
@Deprecated
744766
protected CArray deepClone(CArray array, Target t, ArrayList<CArray[]> cloneRefs) {
745767
return deepClone(array, t, cloneRefs, null);
@@ -790,6 +812,7 @@ private String normalizeConstruct(Mixed c) {
790812
}
791813
}
792814

815+
/** @deprecated Use {@link #remove(int, Environment)} instead. */
793816
@Deprecated
794817
public Mixed remove(int i) {
795818
return remove(i, null);
@@ -806,6 +829,7 @@ public Mixed remove(int i, Environment env) {
806829
return remove(new CInt(i, Target.UNKNOWN), env);
807830
}
808831

832+
/** @deprecated Use {@link #remove(String, Environment)} instead. */
809833
@Deprecated
810834
public Mixed remove(String s) {
811835
return remove(s, null);
@@ -822,6 +846,7 @@ public Mixed remove(String s, Environment env) {
822846
return remove(new CString(s, Target.UNKNOWN), env);
823847
}
824848

849+
/** @deprecated Use {@link #remove(Mixed, Environment)} instead. */
825850
@Deprecated
826851
public Mixed remove(Mixed construct) {
827852
return remove(construct, null);
@@ -884,6 +909,7 @@ public void removeValues(Mixed construct) {
884909
setDirty();
885910
}
886911

912+
/** @deprecated Use {@link #createNew(Target, Environment)} instead. */
887913
@Deprecated
888914
public CArray createNew(Target t) {
889915
return createNew(t, null);
@@ -954,6 +980,8 @@ public boolean canBeAssociative() {
954980
return true;
955981
}
956982

983+
/** @deprecated Use {@link #slice(int, int, Target, Environment)} instead. */
984+
@Deprecated
957985
@Override
958986
public Mixed slice(int begin, int end, Target t) {
959987
return slice(begin, end, t, null);
@@ -1004,6 +1032,7 @@ public enum ArraySortType {
10041032
STRING_IC
10051033
}
10061034

1035+
/** @deprecated Use {@link #sort(ArraySortType, Environment)} instead. */
10071036
@Deprecated
10081037
public void sort(final ArraySortType sort) {
10091038
sort(sort, null);
@@ -1094,6 +1123,7 @@ public int compareString(String o1, String o2) {
10941123
this.setDirty();
10951124
}
10961125

1126+
/** @deprecated Use {@link #isEmpty(Environment)} instead. */
10971127
@Deprecated
10981128
public boolean isEmpty() {
10991129
return isEmpty(null);
@@ -1134,9 +1164,11 @@ public CClassType[] getInterfaces() {
11341164
ArrayAccessSet.TYPE};
11351165
}
11361166

1167+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
1168+
@Deprecated
11371169
@Override
11381170
public boolean getBooleanValue(Target t) {
1139-
return size() > 0;
1171+
return getBooleanValue(null, t);
11401172
}
11411173

11421174
@Override

src/main/java/com/laytonsmith/core/constructs/CBoolean.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ public boolean getBoolean() {
9090
return val;
9191
}
9292

93+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
94+
@Deprecated
9395
@Override
9496
public boolean getBooleanValue(Target t) {
9597
return getBooleanValue(null, t);

src/main/java/com/laytonsmith/core/constructs/CClassType.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,8 @@ public CClassType typeof() {
592592

593593
// TODO: These getters will eventually be re-done to support static methods, but for now that is out of scope,
594594
// so we just specifically support enums for now.
595+
/** @deprecated Use {@link #get(String, Target, Environment)} instead. */
596+
@Deprecated
595597
@Override
596598
public Mixed get(String index, Target t) throws ConfigRuntimeException {
597599
return get(index, t, null);
@@ -609,6 +611,8 @@ public Mixed get(String index, Target t, Environment env) throws ConfigRuntimeEx
609611
throw new CREUnsupportedOperationException("Unsupported operation", t);
610612
}
611613

614+
/** @deprecated Use {@link #get(int, Target, Environment)} instead. */
615+
@Deprecated
612616
@Override
613617
public Mixed get(int index, Target t) throws ConfigRuntimeException {
614618
return get(index, t, null);
@@ -626,6 +630,8 @@ public Mixed get(int index, Target t, Environment env) throws ConfigRuntimeExcep
626630
throw new CREUnsupportedOperationException("Unsupported operation", t);
627631
}
628632

633+
/** @deprecated Use {@link #get(Mixed, Target, Environment)} instead. */
634+
@Deprecated
629635
@Override
630636
public Mixed get(Mixed index, Target t) throws ConfigRuntimeException {
631637
return get(index, t, null);
@@ -643,6 +649,8 @@ public Mixed get(Mixed index, Target t, Environment env) throws ConfigRuntimeExc
643649
throw new CREUnsupportedOperationException("Unsupported operation", t);
644650
}
645651

652+
/** @deprecated Use {@link #keySet(Environment)} instead. */
653+
@Deprecated
646654
@Override
647655
public Set<Mixed> keySet() {
648656
return keySet(null);
@@ -660,6 +668,8 @@ public Set<Mixed> keySet(Environment env) {
660668
return new HashSet<>();
661669
}
662670

671+
/** @deprecated Use {@link #size(Environment)} instead. */
672+
@Deprecated
663673
@Override
664674
public long size() {
665675
return size(null);
@@ -687,6 +697,8 @@ public boolean canBeAssociative() {
687697
return true;
688698
}
689699

700+
/** @deprecated Use {@link #slice(int, int, Target, Environment)} instead. */
701+
@Deprecated
690702
@Override
691703
public Mixed slice(int begin, int end, Target t) {
692704
return slice(begin, end, t, null);
@@ -707,6 +719,8 @@ public Class<? extends Mixed> getNativeType() {
707719
return nativeClass;
708720
}
709721

722+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
723+
@Deprecated
710724
@Override
711725
public boolean getBooleanValue(Target t) {
712726
return getBooleanValue(null, t);

src/main/java/com/laytonsmith/core/constructs/CClosure.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,8 @@ public CClassType[] getInterfaces() {
350350
return new CClassType[]{Callable.TYPE, Booleanish.TYPE};
351351
}
352352

353+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
354+
@Deprecated
353355
@Override
354356
public boolean getBooleanValue(Target t) {
355357
return getBooleanValue(null, t);

src/main/java/com/laytonsmith/core/constructs/CDecimal.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ public CDecimal duplicate() {
8484
return new CDecimal(val, getTarget());
8585
}
8686

87+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
88+
@Deprecated
8789
@Override
8890
public boolean getBooleanValue(Target t) {
8991
return getBooleanValue(null, t);

src/main/java/com/laytonsmith/core/constructs/CMutablePrimitive.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ public void set(Mixed value, Target t) {
5454
this.value = value;
5555
}
5656

57+
/** @deprecated Use {@link #set(Mixed, Mixed, Target, Environment)} instead. */
58+
@Deprecated
5759
@Override
5860
public void set(Mixed index, Mixed c, Target t) {
5961
set(index, c, t, null);
@@ -82,6 +84,8 @@ public Mixed get() {
8284
return value;
8385
}
8486

87+
/** @deprecated Use {@link #get(Mixed, Target, Environment)} instead. */
88+
@Deprecated
8589
@Override
8690
public Mixed get(Mixed index, Target t) {
8791
return get(index, t, null);
@@ -112,6 +116,8 @@ protected String getQuote() {
112116
return new CString(value.val(), Target.UNKNOWN).getQuote();
113117
}
114118

119+
/** @deprecated Use {@link #size(Environment)} instead. */
120+
@Deprecated
115121
@Override
116122
public long size() {
117123
return size(null);

src/main/java/com/laytonsmith/core/constructs/CNull.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ public CClassType[] getInterfaces() {
107107
throw new RuntimeException("Cannot call getInterfaces on null");
108108
}
109109

110+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
111+
@Deprecated
110112
@Override
111113
public boolean getBooleanValue(Target t) {
112114
return getBooleanValue(null, t);

src/main/java/com/laytonsmith/core/constructs/CNumber.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ public Version since() {
4242

4343
public abstract double getNumber();
4444

45+
/** @deprecated Use {@link #getBooleanValue(Environment, Target)} instead. */
46+
@Deprecated
4547
@Override
4648
public boolean getBooleanValue(Target t) {
4749
return getBooleanValue(null, t);

0 commit comments

Comments
 (0)