de.codesourcery.versiontracker.common.ArtifactMap Maven / Gradle / Ivy
/**
* Copyright 2018 Tobias Gierke
*
* 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 de.codesourcery.versiontracker.common;
import org.apache.commons.lang3.Validate;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Spliterator;
import java.util.function.Consumer;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
/**
* A container that stores values indexed by artifact group ID and artifact ID.
*
* This class is NOT thread-safe.
*
*
* @author [email protected]
*/
public class ArtifactMap
{
private Map> data = new HashMap<>();
private int size;
public ArtifactMap() {
}
public ArtifactMap(ArtifactMap other)
{
this.data = new HashMap<>( other.data );
this.size = other.size;
}
/**
* Visits all values in this container.
*
* @param visitor
*/
public void visitValues(Consumer visitor)
{
Validate.notNull(visitor,"visitor must not be NULL");
for ( Entry> mapEntries : data.entrySet() )
{
for ( Entry entries2 : mapEntries.getValue().entrySet() )
{
visitor.accept( entries2.getValue() );
}
}
}
/**
* Removes a values from this container.
*
* @param groupId group ID, must not be null or blank
* @param artifactId artifact ID, must not be null or blank
* @return removed value or null if the value was not found in this container
*/
public T remove(String groupId,String artifactId)
{
Validate.notBlank(groupId,"groupId must not be NULL");
Validate.notBlank(artifactId,"artifactId must not be NULL");
T result = null;
final Map map = data.get( groupId );
if ( map != null ) {
result = map.remove( artifactId );
if ( result != null ) {
size--;
if ( size < 0 ) {
throw new IllegalStateException("Size should never become negative");
}
}
}
return result ;
}
/**
* Returns a {@link Stream} over this collection's values.
*
* @return
*/
public Stream stream()
{
final Spliterator it = new Spliterator<>()
{
private final Iterator>> it1 = data.entrySet().iterator();
private Iterator> it2;
private T next() {
if ( it2 != null && it2.hasNext() ) {
return it2.next().getValue();
}
if ( it1.hasNext() )
{
it2 = it1.next().getValue().entrySet().iterator();
if ( it2.hasNext() ) {
return it2.next().getValue();
}
}
return null;
}
@Override
public int characteristics() {
return 0;
}
@Override
public long estimateSize() {
return Long.MAX_VALUE;
}
@Override
public boolean tryAdvance(Consumer consumer) {
T value = next();
if ( value != null ) {
consumer.accept( value );
}
return value != null;
}
@Override
public Spliterator trySplit() {
return null;
}};
return StreamSupport.stream(it, true );
}
/**
* Removes all values from this container.
*/
public void clear() {
this.data = new HashMap<>();
size = 0;
}
/**
* Returns the number of elements in this container.
*
* @return
*/
public int size() {
return size;
}
/**
* Returns whether this container holds no elements.
*
* @return
*/
public boolean isEmpty() {
return data.isEmpty();
}
/**
* Checks whether this container holds a value for a given group ID and artifact ID.
*
* @param groupId group ID, must not be null or blank
* @param artifactId artifact ID, must not be null or blank
* @return
*/
public boolean contains(String groupId,String artifactId)
{
Validate.notBlank(groupId,"groupId must not be NULL");
Validate.notBlank(artifactId,"artifactId must not be NULL");
final Map map = data.get( groupId );
return map != null && map.containsKey( artifactId );
}
/**
* Stores a value associated with a given group ID and artifact ID.
*
* @param groupId group ID, must not be null or blank
* @param artifactId artifact ID, must not be null or blank
* @param value value to store, never null
* @return old value that was already stored with this group ID and artifact ID or null
*/
public T put(String groupId,String artifactId,T value) {
Validate.notBlank(groupId,"groupId must not be NULL");
Validate.notBlank(artifactId,"artifactId must not be NULL");
Validate.notNull(value,"value must not be NULL");
final Map map = data.computeIfAbsent( groupId, k -> new HashMap<>() );
T existing = map.put( artifactId, value );
if ( existing == null ) {
size++;
}
return existing;
}
/**
* Retrieves a value by group ID and artifact ID.
*
* @param groupId group ID, must not be null or blank
* @param artifactId artifact ID, must not be null or blank
*
* @return value or null
*/
public T get(String groupId,String artifactId) {
Validate.notBlank(groupId,"groupId must not be NULL");
Validate.notBlank(artifactId,"artifactId must not be NULL");
final Map map = data.get( groupId );
return map != null ? map.get( artifactId ) : null;
}
/**
* Adds all entries from another ArtifactMap to this one.
*/
public void putAll(ArtifactMap other)
{
for ( Entry> entry : other.data.entrySet() )
{
final Map existing = this.data.computeIfAbsent( entry.getKey(), k -> new HashMap<>( entry.getValue().size() ) );
existing.putAll( entry.getValue() );
}
}
}