Package dev.zemco.codegame.presentation

Class ResourceFxmlViewSourceProvider

java.lang.Object

dev.zemco.codegame.presentation.ResourceFxmlViewSourceProvider

All Implemented Interfaces:

IFxmlViewSourceProvider

public class ResourceFxmlViewSourceProvider
extends Object
implements IFxmlViewSourceProvider

Provides the JavaFX FXML sources from resources of the specified class for specified views. This implementation's view mappings are immutable.

Author:

Erik Zemčík

Constructor Summary

Constructors

Constructor	Description
ResourceFxmlViewSourceProvider(Class<?> resourceClass, Map<String,String> viewIdToFxmlResourcePathMap)	Creates an instance of ResourceFxmlViewSourceProvider.

Method Summary

Modifier and Type	Method	Description
InputStream	getFxmlViewSourceStreamById(String viewId)	Provides an input stream with the raw FXML source of the requested view.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceFxmlViewSourceProvider

public ResourceFxmlViewSourceProvider(Class<?> resourceClass,
 Map<String,String> viewIdToFxmlResourcePathMap)

Creates an instance of ResourceFxmlViewSourceProvider. The resources are retrieved from the given resource class. The view mappings cannot be modified after the construction.

Parameters:

resourceClass - class to use as source of resources

viewIdToFxmlResourcePathMap - mappings of view ids to their respective FXML source resources

Throws:

IllegalArgumentException - if resourceClass is null or if viewIdToFxmlResourcePathMap is null

Method Details

getFxmlViewSourceStreamById

public InputStream getFxmlViewSourceStreamById(String viewId)

Provides an input stream with the raw FXML source of the requested view.

The view is identified by the viewId parameter, and is resolved through the view mappings given during the construction of the provider. The resource streams are retrieved from the resource class using the Class.getResourceAsStream(String) method.

Specified by:

getFxmlViewSourceStreamById in interface IFxmlViewSourceProvider

Parameters:

viewId - identification of the view

Returns:

input stream with the raw FXML source

Throws:

IllegalArgumentException - if viewId is null or empty

UnknownViewException - when the viewId is not known by the provider

ResourceLoadException - if the resource specified by the mappings is not available in the resource class

See Also:

• Class.getResourceAsStream(String)