Package repast.simphony.scenario.data

Class UserPathData

java.lang.Object

repast.simphony.scenario.data.UserPathData

public class UserPathData
extends Object

Encapsulates metadata about a model, the classpath etc.

Author:

Nick Collier

Constructor Summary

Constructors

Constructor	Description
UserPathData(String name)

Method Summary

Modifier and Type	Method	Description
void	addAgentEntry(String path, List<String> filters)	Adds the specified path as path on which agent classes can be found.
void	addEntry(String entry, boolean processAnnotations)	Adds the specified entry to the classpath.
Iterable<ClassPathEntry>	agentEntries()	Gets an iterable over the AgentPath entries in this model data.
Iterable<ClassPathEntry>	annotationCPEntries()	Gets an iterable over all the classpath entries that should be processed for annotations.
Iterable<ClassPathEntry>	classpathEntries()	Gets an iterable over all the classpath entries.
int	getAgentEntryCount()	Gets the number of agent entries in this model data.
String	getName()	Gets the name the model.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPathData

public UserPathData(String name)

Method Detail

getName

public String getName()

Gets the name the model.

Returns:

the name the model.

addEntry

public void addEntry(String entry,
                     boolean processAnnotations)

Adds the specified entry to the classpath. If the entry is a directory and it contains any .class files or its children of the directory contain any .class path the directory itself will be added. If the directory contains any jar files those will be added as well.

If the entry ends with .jar that jar file will be added.

Parameters:

directory - the directory to add

processAnnotations - whether or not the entry should be processed for annotations

addAgentEntry

public void addAgentEntry(String path,
                          List<String> filters)

Adds the specified path as path on which agent classes can be found.

Parameters:

path - the path entry

filters -

getAgentEntryCount

public int getAgentEntryCount()

Gets the number of agent entries in this model data.

Returns:

the number of agent entries in this model data.

agentEntries

public Iterable<ClassPathEntry> agentEntries()

Gets an iterable over the AgentPath entries in this model data.

Returns:

an iterable over the AgentPath entries in this model data.

classpathEntries

public Iterable<ClassPathEntry> classpathEntries()

Gets an iterable over all the classpath entries.

Returns:

an iterable over all the classpath entries.

annotationCPEntries

public Iterable<ClassPathEntry> annotationCPEntries()

Gets an iterable over all the classpath entries that should be processed for annotations.

Returns:

an iterable over all the classpath entries that should be processed for annotations.