org.codehaus.groovy.vmplugin.v8.PluginDefaultGroovyMethods Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of groovy Show documentation
Show all versions of groovy Show documentation
Groovy: A powerful multi-faceted language for the JVM
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.codehaus.groovy.vmplugin.v8;
import groovy.lang.Closure;
import groovy.lang.EmptyRange;
import groovy.lang.GString;
import groovy.lang.IntRange;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FirstParam;
import org.codehaus.groovy.runtime.DefaultGroovyMethodsSupport;
import org.codehaus.groovy.runtime.InvokerHelper;
import org.codehaus.groovy.runtime.NullObject;
import org.codehaus.groovy.runtime.RangeInfo;
import org.codehaus.groovy.runtime.StreamGroovyMethods;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;
import java.util.Set;
import java.util.Spliterator;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.function.DoubleFunction;
import java.util.function.DoublePredicate;
import java.util.function.IntFunction;
import java.util.function.IntPredicate;
import java.util.function.LongFunction;
import java.util.function.LongPredicate;
import java.util.function.Supplier;
import java.util.function.ToDoubleFunction;
import java.util.function.ToIntFunction;
import java.util.function.ToLongFunction;
import java.util.stream.BaseStream;
import java.util.stream.DoubleStream;
import java.util.stream.IntStream;
import java.util.stream.LongStream;
import java.util.stream.Stream;
/**
* Defines new Groovy methods which appear on standard Java 8 classes within the
* Groovy environment.
*
* @since 2.5.0
*/
public class PluginDefaultGroovyMethods extends DefaultGroovyMethodsSupport {
private PluginDefaultGroovyMethods() {
}
//--------------------------------------------------------------------------
// Enum
/**
* Overloads the {@code ++} operator for enums. It will invoke Groovy's
* default next behaviour for enums that do not have their own next method.
*
* @param self an Enum
* @return the next defined enum from the enum class
*
* @since 1.5.2
*/
public static Object next(final Enum self) {
for (Method method : self.getClass().getMethods()) {
if (method.getName().equals("next") && method.getParameterCount() == 0) {
return InvokerHelper.invokeMethod(self, "next", InvokerHelper.EMPTY_ARGS);
}
}
Object[] values = (Object[]) InvokerHelper.invokeStaticMethod(self.getClass(), "values", InvokerHelper.EMPTY_ARGS);
int index = Arrays.asList(values).indexOf(self);
return values[index < values.length - 1 ? index + 1 : 0];
}
/**
* Overloads the {@code --} operator for enums. It will invoke Groovy's
* default previous behaviour for enums that do not have their own previous method.
*
* @param self an Enum
* @return the previous defined enum from the enum class
*
* @since 1.5.2
*/
public static Object previous(final Enum self) {
for (Method method : self.getClass().getMethods()) {
if (method.getName().equals("previous") && method.getParameterCount() == 0) {
return InvokerHelper.invokeMethod(self, "previous", InvokerHelper.EMPTY_ARGS);
}
}
Object[] values = (Object[]) InvokerHelper.invokeStaticMethod(self.getClass(), "values", InvokerHelper.EMPTY_ARGS);
int index = Arrays.asList(values).indexOf(self);
return values[index > 0 ? index - 1 : values.length - 1];
}
//--------------------------------------------------------------------------
// Future
/**
* Returns a Future asynchronously returning a transformed result.
*
* import java.util.concurrent.*
* def executor = Executors.newSingleThreadExecutor()
* Future foobar = executor.submit{ "foobar" }
* Future foobarSize = foobar.collect{ it.size() }
* assert foobarSize.get() == 6
* executor.shutdown()
*
*
* @param self a Future
* @param transform the closure used to transform the Future value
* @return a Future allowing the transformed value to be obtained asynchronously
*
* @since 3.0.0
*/
public static Future collect(final Future self, @ClosureParams(FirstParam.FirstGenericType.class) final Closure transform) {
Objects.requireNonNull(self);
Objects.requireNonNull(transform);
return new TransformedFuture(self, transform);
}
private static class TransformedFuture implements Future {
private final Future delegate;
private final Closure transform;
private TransformedFuture(final Future delegate, final Closure transform) {
this.delegate = delegate;
this.transform = transform;
}
@Override
public boolean cancel(final boolean mayInterruptIfRunning) {
return delegate.cancel(mayInterruptIfRunning);
}
@Override
public boolean isCancelled() {
return delegate.isCancelled();
}
@Override
public boolean isDone() {
return delegate.isDone();
}
@Override
public E get() throws InterruptedException, ExecutionException {
return transform.call(delegate.get());
}
@Override
public E get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException {
return transform.call(delegate.get(timeout, unit));
}
}
//--------------------------------------------------------------------------
// Optional
/**
* Coerce an {@code Optional} instance to a {@code boolean} value.
*
* assert !Optional.empty().asBoolean()
* assert Optional.of(1234).asBoolean()
*
*
* @param optional the Optional
* @return {@code true} if a value is present, otherwise {@code false}
*
* @since 2.5.0
*/
public static boolean asBoolean(final Optional optional) {
return optional.isPresent();
}
/**
* If a value is present in the {@code OptionalInt}, returns the value,
* otherwise throws {@code NoSuchElementException}.
*
* assert OptionalInt.of(1234).get() == 1234
*
*
* @since 3.0.0
*/
public static int get(final OptionalInt self) {
return self.getAsInt();
}
/**
* If a value is present in the {@code OptionalLong}, returns the value,
* otherwise throws {@code NoSuchElementException}.
*
* assert OptionalLong.of(1234L).get() == 1234L
*
*
* @since 3.0.0
*/
public static long get(final OptionalLong self) {
return self.getAsLong();
}
/**
* If a value is present in the {@code OptionalDouble}, returns the value,
* otherwise throws {@code NoSuchElementException}.
*
* assert OptionalDouble.of(Math.PI).get() == Math.PI
*
*
* @since 3.0.0
*/
public static double get(final OptionalDouble self) {
return self.getAsDouble();
}
/**
* If the optional contains a value, returns an optional containing the transformed value obtained using the transform closure
* or otherwise an empty optional.
*
* assert Optional.of("foobar").collect{ it.size() }.get() == 6
* assert !Optional.empty().collect{ it.size() }.isPresent()
*
*
* @param self an Optional
* @param transform the closure used to transform the optional value if present
* @return an Optional containing the transformed value or empty if the optional is empty or the transform returns null
*
* @since 3.0.0
*/
public static Optional collect(final Optional self, @ClosureParams(FirstParam.FirstGenericType.class) final Closure transform) {
Objects.requireNonNull(self);
Objects.requireNonNull(transform);
return self.map(transform::call);
}
/**
* Tests given value against specified type and changes generics of result.
* This is equivalent to: self.filter(it -> it instanceof Type).map(it -> (Type) it)
*
* assert !Optional.empty().filter(Number).isPresent()
* assert !Optional.of('x').filter(Number).isPresent()
* assert Optional.of(1234).filter(Number).isPresent()
* assert Optional.of(1234).filter(Number).get().equals(1234)
*
*
* @since 3.0.0
*/
public static Optional filter(final Optional self, final Class type) {
return self.filter(type::isInstance).map(type::cast);
}
/**
* If a value is present in the {@code OptionalInt}, tests the value using
* the given predicate and returns the optional if the test returns true or
* else empty.
*
* assert !OptionalInt.empty().filter(i -> true).isPresent()
* assert OptionalInt.of(1234).filter(i -> true).isPresent()
* assert !OptionalInt.of(1234).filter(i -> false).isPresent()
* assert OptionalInt.of(1234).filter(i -> true).getAsInt() == 1234
*
*
* @since 3.0.0
*/
public static OptionalInt filter(final OptionalInt self, final IntPredicate test) {
if (!self.isPresent() || !test.test(self.getAsInt())) {
return OptionalInt.empty();
}
return self;
}
/**
* If a value is present in the {@code OptionalLong}, tests the value using
* the given predicate and returns the optional if the test returns true or
* else empty.
*
* assert !OptionalLong.empty().filter(n -> true).isPresent()
* assert OptionalLong.of(123L).filter(n -> true).isPresent()
* assert !OptionalLong.of(123L).filter(n -> false).isPresent()
* assert OptionalLong.of(123L).filter(n -> true).getAsLong() == 123L
*
*
* @since 3.0.0
*/
public static OptionalLong filter(final OptionalLong self, final LongPredicate test) {
if (!self.isPresent() || !test.test(self.getAsLong())) {
return OptionalLong.empty();
}
return self;
}
/**
* If a value is present in the {@code OptionalDouble}, tests the value using
* the given predicate and returns the optional if the test returns true or
* empty otherwise.
*
* assert !OptionalDouble.empty().filter(n -> true).isPresent()
* assert OptionalDouble.of(Math.PI).filter(n -> true).isPresent()
* assert !OptionalDouble.of(Math.PI).filter(n -> false).isPresent()
* assert OptionalDouble.of(Math.PI).filter(n -> true).getAsDouble() == Math.PI
*
*
* @since 3.0.0
*/
public static OptionalDouble filter(final OptionalDouble self, final DoublePredicate test) {
if (!self.isPresent() || !test.test(self.getAsDouble())) {
return OptionalDouble.empty();
}
return self;
}
/**
* If a value is present in the {@code OptionalInt}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !OptionalInt.empty().mapToObj(x -> new Object()).isPresent()
* assert OptionalInt.of(1234).mapToObj(x -> new Object()).isPresent()
* assert !OptionalInt.of(1234).mapToObj(x -> null).isPresent()
* assert OptionalInt.of(1234).mapToObj(Integer::toString).get() == '1234'
*
*
* @since 3.0.0
*/
public static Optional mapToObj(final OptionalInt self, final IntFunction mapper) {
if (!self.isPresent()) {
return Optional.empty();
}
return Optional.ofNullable(mapper.apply(self.getAsInt()));
}
/**
* If a value is present in the {@code OptionalLong}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !OptionalLong.empty().mapToObj(x -> new Object()).isPresent()
* assert OptionalLong.of(123L).mapToObj(x -> new Object()).isPresent()
* assert !OptionalLong.of(123L).mapToObj(x -> null).isPresent()
* assert OptionalLong.of(1234L).mapToObj(Long::toString).get() == '1234'
*
*
* @since 3.0.0
*/
public static Optional mapToObj(final OptionalLong self, final LongFunction mapper) {
if (!self.isPresent()) {
return Optional.empty();
}
return Optional.ofNullable(mapper.apply(self.getAsLong()));
}
/**
* If a value is present in the {@code OptionalDouble}, returns an {@code Optional}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !OptionalDouble.empty().mapToObj(x -> new Object()).isPresent()
* assert OptionalDouble.of(Math.PI).mapToObj(x -> new Object()).isPresent()
* assert !OptionalDouble.of(Math.PI).mapToObj(x -> null).isPresent()
* assert OptionalDouble.of(Math.PI).mapToObj(Double::toString).get().startsWith('3.14')
*
*
* @since 3.0.0
*/
public static Optional mapToObj(final OptionalDouble self, final DoubleFunction mapper) {
if (!self.isPresent()) {
return Optional.empty();
}
return Optional.ofNullable(mapper.apply(self.getAsDouble()));
}
/**
* If a value is present in the {@code OptionalInt}, returns an {@code OptionalInt}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !Optional.empty().mapToInt(x -> 42).isPresent()
* assert Optional.of('x').mapToInt(x -> 42).getAsInt() == 42
*
*
* @since 3.0.0
*/
public static OptionalInt mapToInt(final Optional self, final ToIntFunction mapper) {
return self.map(t -> OptionalInt.of(mapper.applyAsInt(t))).orElseGet(OptionalInt::empty);
}
/**
* If a value is present in the {@code OptionalLong}, returns an {@code OptionalLong}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !Optional.empty().mapToLong(x -> 42L).isPresent()
* assert Optional.of('x').mapToLong(x -> 42L).getAsLong() == 42L
*
*
* @since 3.0.0
*/
public static OptionalLong mapToLong(final Optional self, final ToLongFunction mapper) {
return self.map(t -> OptionalLong.of(mapper.applyAsLong(t))).orElseGet(OptionalLong::empty);
}
/**
* If a value is present in the {@code OptionalDouble}, returns an {@code OptionalDouble}
* consisting of the result of applying the given function to the value or else empty.
*
* assert !Optional.empty().mapToDouble(x -> Math.PI).isPresent()
* assert Optional.of('x').mapToDouble(x -> Math.PI).getAsDouble() == Math.PI
*
*
* @since 3.0.0
*/
public static OptionalDouble mapToDouble(final Optional self, final ToDoubleFunction mapper) {
return self.map(t -> OptionalDouble.of(mapper.applyAsDouble(t))).orElseGet(OptionalDouble::empty);
}
/**
* Provides similar functionality to JDK9 {@code or} on JDK8.
*
*
* def x = Optional.empty()
* def y = Optional.of('y')
* assert y.orOptional(() -> Optional.of('z')).get() == 'y'
* assert x.orOptional(() -> Optional.of('z')).get() == 'z'
*
*
* @since 3.0.6
*/
public static Optional orOptional(final Optional self, final Supplier> supplier) {
if (self.isPresent()) {
return self;
}
return (Optional) supplier.get();
}
//--------------------------------------------------------------------------
// Runtime
/**
* Gets the pid of the current Java process.
*
* @since 4.0.0
*/
public static String getPid(final Runtime self) {
String name = java.lang.management.ManagementFactory.getRuntimeMXBean().getName();
int index = name.indexOf('@');
if (index == -1) { // should never happen
return name;
}
return name.substring(0, index);
}
//--------------------------------------------------------------------------
// StringBuilder
/**
* Overloads the left shift operator to provide an easy way to append multiple
* objects as string representations to a StringBuilder.
*
* @param self a StringBuilder
* @param value a value to append
* @return the StringBuilder on which this operation was invoked
*
* @since 1.5.2
*/
public static StringBuilder leftShift(final StringBuilder self, final Object value) {
if (value instanceof GString) {
// Force the conversion of the GString to string now, or appending
// is going to be extremely expensive, due to calls to GString#charAt,
// which is going to re-evaluate the GString for each character!
return self.append(value.toString());
}
if (value instanceof CharSequence) {
return self.append((CharSequence)value);
}
return self.append(value);
}
/**
* Appends a String to this StringBuilder.
*
* @param self a StringBuilder
* @param value a String
* @return a String
*
* @since 1.5.2
*/
public static String plus(final StringBuilder self, final String value) {
return self + value;
}
/**
* Supports the range subscript operator for StringBuilder.
*
* @param self a StringBuilder
* @param range a Range
* @param value the object that's toString() will be inserted
*
* @since 1.5.2
*/
public static void putAt(final StringBuilder self, final EmptyRange range, final Object value) {
RangeInfo info = subListBorders(self.length(), range);
self.replace(info.from, info.to, value.toString());
}
/**
* Supports the range subscript operator for StringBuilder.
* Index values are treated as characters within the builder.
*
* @param self a StringBuilder
* @param range a Range
* @param value the object that's toString() will be inserted
*
* @since 1.5.2
*/
public static void putAt(final StringBuilder self, final IntRange range, final Object value) {
RangeInfo info = subListBorders(self.length(), range);
self.replace(info.from, info.to, value.toString());
}
/**
* Provides the standard Groovy {@code size()} method for StringBuilder.
*
* @param self a StringBuilder
* @return the length of the StringBuilder
*
* @since 1.5.2
*
* @see org.codehaus.groovy.runtime.StringGroovyMethods#size(CharSequence)
*/
@Deprecated
public static int size(final StringBuilder self) {
return self.length();
}
//--------------------------------------------------------------------------
@Deprecated
public static Stream stream(final T self) {
return Stream.of(self);
}
@Deprecated
public static Stream stream(final T[] self) {
return Arrays.stream(self);
}
@Deprecated
public static Stream stream(final int[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final long[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final double[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final char[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final byte[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final short[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final boolean[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final float[] self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final Enumeration self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final Iterable self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final Iterator self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final Spliterator self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static Stream stream(final NullObject self) {
return Stream.empty();
}
@Deprecated
public static Stream stream(final Optional self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static IntStream stream(final OptionalInt self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static LongStream stream(final OptionalLong self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static DoubleStream stream(final OptionalDouble self) {
return StreamGroovyMethods.stream(self);
}
@Deprecated
public static IntStream intStream(final int[] self) {
return Arrays.stream(self);
}
@Deprecated
public static LongStream longStream(final long[] self) {
return Arrays.stream(self);
}
@Deprecated
public static DoubleStream doubleStream(final double[] self) {
return Arrays.stream(self);
}
@Deprecated
public static T[] toArray(final Stream self, final Class type) {
return StreamGroovyMethods.toArray(self, type);
}
@Deprecated
public static List toList(final Stream self) {
return StreamGroovyMethods.toList(self);
}
@Deprecated
public static List toList(final BaseStream self) {
return StreamGroovyMethods.toList(self);
}
@Deprecated
public static Set toSet(final Stream self) {
return StreamGroovyMethods.toSet(self);
}
@Deprecated
public static Set toSet(final BaseStream self) {
return StreamGroovyMethods.toSet(self);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy