org.springframework.cloud.contract.verifier.util

Class ContractScanner

java.lang.Object

org.springframework.cloud.contract.verifier.util.ContractScanner

public final class ContractScanner
extends Object

Scans through the given directory and converts all files for contract definitions.

Since:

2.1.0

Author:

Marcin Grzejszczak, Anatolii Zhmaiev

Method Summary

Modifier and Type	Method and Description
static Collection<org.springframework.cloud.contract.spec.Contract>	collectContractDescriptors(File rootDirectory) Traverses through the directories, applies converters to files that match them and converts the files to Contract.
static Collection<org.springframework.cloud.contract.spec.Contract>	collectContractDescriptors(File rootDirectory, Predicate<File> predicate) Traverses through the directories, applies converters to files that match them and converts the files to Contract.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

collectContractDescriptors

public static Collection<org.springframework.cloud.contract.spec.Contract> collectContractDescriptors(File rootDirectory)

Traverses through the directories, applies converters to files that match them and converts the files to Contract. No additional file filtering takes place.

Parameters:

rootDirectory - - directory to traverse through

Returns:

collection of converted contracts

collectContractDescriptors

public static Collection<org.springframework.cloud.contract.spec.Contract> collectContractDescriptors(File rootDirectory,
                                                                                                      Predicate<File> predicate)

Traverses through the directories, applies converters to files that match them and converts the files to Contract. Filters out files not matching a predicate.

Parameters:

rootDirectory - - directory to traverse through

predicate - - test applied against a file

Returns:

collection of converted contracts