Package org.eclipse.aether.internal.impl.filter.prefixes

Interface PrefixesSource

public interface PrefixesSource

Prefixes source and parser.

This class is "clean room" reimplementation of original class.

Since:

2.0.11

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PrefixesSource.Parser

Method Summary

Modifier and Type	Method	Description
List<String>	entries()	The prefix entries.
String	message()	Message worth logging if valid() returns false.
static PrefixesSource	of(org.eclipse.aether.repository.RemoteRepository origin, Path path)	Creates PrefixesSource out of passed in parameters, never returns null.
org.eclipse.aether.repository.RemoteRepository	origin()	The origin repository of this source.
Path	path()	The file path (ie local repository or user provided one) this source got entries from.
boolean	valid()	Returns true if source is valid and contains valid entries.

Method Details

origin

org.eclipse.aether.repository.RemoteRepository origin()

The origin repository of this source.

path

Path path()

The file path (ie local repository or user provided one) this source got entries from.

message

String message()

Message worth logging if valid() returns false.

valid

boolean valid()

Returns true if source is valid and contains valid entries.

entries

List<String> entries()

The prefix entries.

of

static PrefixesSource of(org.eclipse.aether.repository.RemoteRepository origin,
 Path path)

Creates PrefixesSource out of passed in parameters, never returns null. The returned source should be checked for valid() and use only if it returns true.

This method is "forgiving" to all kind of IO problems while reading (file not found, etc.) and will never throw IOException as prefix file processing should not interrupt main flow due which prefix file processing is happening in the first place. Ideally, user is notified at least by logging if any problem happens.