org.gradle.api.internal.collections.AbstractIterationOrderRetainingElementSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2018 the original author or authors.
*
* Licensed 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.gradle.api.internal.collections;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterators;
import org.gradle.api.Action;
import org.gradle.api.internal.DefaultMutationGuard;
import org.gradle.api.internal.MutationGuard;
import org.gradle.api.internal.provider.ChangingValue;
import org.gradle.api.internal.provider.CollectionProviderInternal;
import org.gradle.api.internal.provider.Collector;
import org.gradle.api.internal.provider.Collectors.ElementFromProvider;
import org.gradle.api.internal.provider.Collectors.ElementsFromCollectionProvider;
import org.gradle.api.internal.provider.Collectors.SingleElement;
import org.gradle.api.internal.provider.Collectors.TypedCollector;
import org.gradle.api.internal.provider.ProviderInternal;
import org.gradle.api.specs.Spec;
import org.gradle.internal.Cast;
import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.ConcurrentModificationException;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Set;
abstract public class AbstractIterationOrderRetainingElementSource implements ElementSource {
// This set represents the order in which elements are inserted to the store, either actual
// or provided. We construct a correct iteration order from this set.
private final List> inserted = new ArrayList<>();
private final MutationGuard mutationGuard = new DefaultMutationGuard();
private Action pendingAddedAction;
private EventSubscriptionVerifier subscriptionVerifier = type -> false;
protected int modCount;
List> getInserted() {
return inserted;
}
@Override
public boolean isEmpty() {
return inserted.isEmpty();
}
@Override
public boolean constantTimeIsEmpty() {
return inserted.isEmpty();
}
@Override
public int size() {
int count = 0;
for (Element element : inserted) {
count += element.size();
}
return count;
}
@Override
public int estimatedSize() {
return size();
}
@Override
public boolean contains(Object element) {
return Iterators.contains(iterator(), element);
}
@Override
public boolean containsAll(Collection elements) {
for (Object e : elements) {
if (!contains(e)) {
return false;
}
}
return true;
}
@Override
public boolean remove(Object o) {
Iterator iterator = iteratorNoFlush();
while (iterator.hasNext()) {
T value = iterator.next();
if (value.equals(o)) {
iterator.remove();
modCount++;
return true;
}
}
return false;
}
@Override
public void clear() {
modCount++;
inserted.clear();
}
@Override
public void realizeExternal(ProviderInternal provider) {
}
@Override
public void realizePending() {
for (Element element : inserted) {
if (!element.isRealized()) {
modCount++;
element.realize();
}
}
}
@Override
public void realizePending(Class type) {
for (Element element : inserted) {
if (!element.isRealized() && (element.getType() == null || type.isAssignableFrom(element.getType()))) {
modCount++;
element.realize();
}
}
}
protected void clearCachedElement(Element element) {
modCount++;
element.clearCache();
}
Element cachingElement(ProviderInternal provider) {
final Element element = new Element<>(provider.getType(), new ElementFromProvider<>(provider), this::doAddRealized);
if (provider instanceof ChangingValue) {
Cast.>uncheckedNonnullCast(provider).onValueChange(previousValue -> clearCachedElement(element));
}
return element;
}
Element cachingElement(CollectionProviderInternal> provider) {
final Element element = new Element<>(provider.getElementType(), new ElementsFromCollectionProvider<>(provider), this::doAddRealized);
if (provider instanceof ChangingValue) {
Cast.>>uncheckedNonnullCast(provider).onValueChange(previousValues -> clearCachedElement(element));
}
return element;
}
private void doAddRealized(T value) {
if (addRealized(value) && pendingAddedAction != null) {
pendingAddedAction.execute(value);
}
}
abstract boolean addRealized(T element);
@Override
public boolean removePending(ProviderInternal provider) {
return removeByProvider(provider);
}
private boolean removeByProvider(ProviderInternal provider) {
Iterator> iterator = inserted.iterator();
while (iterator.hasNext()) {
Element next = iterator.next();
if (!next.isRealized() && next.isProvidedBy(provider)) {
modCount++;
iterator.remove();
return true;
}
}
return false;
}
@Override
public boolean removePendingCollection(CollectionProviderInternal> provider) {
return removeByProvider(provider);
}
@Override
public void onPendingAdded(final Action action) {
this.pendingAddedAction = action;
}
@Override
public void setSubscriptionVerifier(EventSubscriptionVerifier subscriptionVerifier) {
this.subscriptionVerifier = subscriptionVerifier;
}
protected boolean addPendingElement(Element element) {
boolean added = inserted.add(element);
if (subscriptionVerifier.isSubscribed(element.getType())) {
element.realize();
// Ugly backwards-compatibility hack. Previous implementations would notify listeners without
// actually telling the ElementSource that the element was realized.
// We can avoid this in the future if we make ChangingValue more widespread -- particularly
// if we make CollectionProviders implement ChangingValue
element.clearCache();
}
return added;
}
@Override
public MutationGuard getMutationGuard() {
return mutationGuard;
}
protected class RealizedElementCollectionIterator implements Iterator {
final List> backingList;
final Spec> acceptanceSpec;
int nextIndex = -1;
int nextSubIndex = -1;
int previousIndex = -1;
int previousSubIndex = -1;
T next;
int expectedModCount = modCount;
RealizedElementCollectionIterator(List> backingList, Spec> acceptanceSpec) {
this.backingList = backingList;
this.acceptanceSpec = acceptanceSpec;
updateNext();
}
@Override
public boolean hasNext() {
return next != null;
}
private void updateNext() {
if (nextIndex == -1) {
nextIndex = 0;
}
int i = nextIndex;
while (i < backingList.size()) {
Element candidate = backingList.get(i);
if (candidate.isRealized()) {
List collected = candidate.getValues();
int j = nextSubIndex + 1;
while (j < collected.size()) {
T value = collected.get(j);
if (acceptanceSpec.isSatisfiedBy(new ValuePointer(candidate, j))) {
nextIndex = i;
nextSubIndex = j;
next = value;
return;
}
j++;
}
nextSubIndex = -1;
}
i++;
}
nextIndex = i;
next = null;
}
@Override
public T next() {
checkForComodification();
if (next == null) {
throw new NoSuchElementException();
}
T thisNext = next;
previousIndex = nextIndex;
previousSubIndex = nextSubIndex;
updateNext();
return thisNext;
}
@Override
public void remove() {
if (previousIndex > -1) {
checkForComodification();
Element element = backingList.get(previousIndex);
List collected = element.getValues();
if (collected.size() > 1) {
element.remove(collected.get(previousSubIndex));
nextSubIndex--;
} else {
backingList.remove(previousIndex);
nextIndex--;
}
previousIndex = -1;
previousSubIndex = -1;
} else {
throw new IllegalStateException();
}
}
final void checkForComodification() {
if (modCount != expectedModCount) {
throw new ConcurrentModificationException();
}
}
}
protected static class Element extends TypedCollector {
private List cache;
private final List removedValues = new ArrayList<>();
private final Set realizedValues = new HashSet<>();
private final Set duplicates = new HashSet<>(); // TODO IntSet
private boolean realized;
private final Action realizeAction;
Element(@Nullable Class type, Collector delegate, Action realizeAction) {
super(type, delegate);
this.realizeAction = realizeAction;
}
Element(T value) {
super(null, new SingleElement(value));
this.realizeAction = null;
realize();
}
public boolean isRealized() {
return realized;
}
public void realize() {
if (cache == null) {
ImmutableList.Builder builder = ImmutableList.builderWithExpectedSize(delegate.size());
// Collect elements discarding potential side effects aggregated in the returned value
super.collectInto(builder);
cache = new ArrayList<>(builder.build());
cache.removeAll(removedValues);
realized = true;
if (realizeAction != null) {
for (T value : cache) {
if (!realizedValues.contains(value)) {
realizeAction.execute(value);
realizedValues.add(value);
}
}
}
}
}
@Override
public void collectInto(ImmutableCollection.Builder builder) {
if (!realized) {
realize();
}
builder.addAll(cache);
}
List getValues() {
if (!realized) {
realize();
}
return cache;
}
public boolean remove(T value) {
removedValues.add(value);
if (cache != null) {
return cache.remove(value);
}
return true;
}
boolean isDuplicate(int index) {
return duplicates.contains(index);
}
void setDuplicate(int index) {
duplicates.add(index);
}
void clearCache() {
cache = null;
realized = false;
duplicates.clear();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Element that = (Element) o;
return Objects.equal(delegate, that.delegate) &&
Objects.equal(cache, that.cache);
}
@Override
public int hashCode() {
return Objects.hashCode(delegate, cache);
}
}
protected static class ValuePointer {
private final Element element;
private final Integer index;
public ValuePointer(Element element, Integer index) {
this.element = element;
this.index = index;
}
public Element getElement() {
return element;
}
public Integer getIndex() {
return index;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy