SubCollectionConstraint (Open Traffic Sim base classes 1.04.04 API)

java.lang.Object
- org.opentrafficsim.base.parameters.constraint.SubCollectionConstraint<T>

Type Parameters:

T - object type

All Implemented Interfaces:

Constraint<Collection<T>>

Direct Known Subclasses:

ClassCollectionConstraint
```
public class SubCollectionConstraint<T>
extends Object
implements Constraint<Collection<T>>
```
Constraint that checks whether a collection (the parameter value) is a subset of a constraint collection.
Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 10 sep. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Field Summary

Fields
Modifier and Type Field Description

protected Collection<T> objects
Acceptable objects.

Constructor Summary

Constructors
Constructor Description

SubCollectionConstraint(Collection<T> objects)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(Collection<T> value)`	Checks whether the value complies with constraints.
`String`	`failMessage()`	Returns a message for value failure, pointing to a parameter using '%s'.
`static <T> SubCollectionConstraint<T>`	`newInstance(T... objs)`	Creates a new instance with given collection.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - objects
```
protected final Collection<T> objects
```
    Acceptable objects.
- Constructor Detail
  - SubCollectionConstraint
```
public SubCollectionConstraint(Collection<T> objects)
```
    Parameters:
    
    objects - Collection<T>; acceptable objects
- Method Detail
  - accept
```
public boolean accept(Collection<T> value)
```
    Checks whether the value complies with constraints.
    
    Specified by:
    
    accept in interface Constraint<T>
    
    Parameters:
    
    value - T; Value to check.
    
    Returns:
    
    Whether the value complies with constraints.
  - failMessage
```
public String failMessage()
```
    Returns a message for value failure, pointing to a parameter using '%s'.
    
    Specified by:
    
    failMessage in interface Constraint<T>
    
    Returns:
    
    Message for value failure, pointing to a parameter using '%s'.
  - newInstance
```
@SafeVarargs
public static <T> SubCollectionConstraint<T> newInstance(T... objs)
```
    Creates a new instance with given collection.
    
    Type Parameters:
    
    T - type
    
    Parameters:
    
    objs - T...; acceptable objects
    
    Returns:
    
    new instance with given collection
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object