Package com.flowingcode.vaadin.addons.demo

Class DefaultSourceUrlResolver

java.lang.Object

com.flowingcode.vaadin.addons.demo.DefaultSourceUrlResolver

All Implemented Interfaces:

SourceUrlResolver

public class DefaultSourceUrlResolver
extends Object
implements SourceUrlResolver

Implementation of SourceUrlResolver.

If no value or clazz is specified, and the demo view is annotated with GithubLink, then the source URL defaults to the location of the annotated class under src/test/java and the branch is determined from the value of GithubBranch in the demo view class (if the annotation is present) or the containing package of the demo view class. If the source URL is defaulted and no GithubBranch annotation is present either in the demo view class or its containing package, then the branch defaults to master.

Author:

Javier Godoy / Flowing Code

Constructor Summary

Constructors

Constructor	Description
DefaultSourceUrlResolver()

Method Summary

Modifier and Type	Method	Description
Optional<String>	resolveURL(TabbedDemo demo, Class<?> annotatedClass, DemoSource annotation)	Resolves the source URL for a given demo class and annotation.
Optional<String>	resolveURL(Class<? extends TabbedDemo> viewClass, Class<?> annotatedClass, DemoSource annotation)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSourceUrlResolver

public DefaultSourceUrlResolver()

Method Details

resolveURL

public Optional<String> resolveURL(TabbedDemo demo,
 Class<?> annotatedClass,
 DemoSource annotation)

Description copied from interface: SourceUrlResolver

Resolves the source URL for a given demo class and annotation.

Specified by:

resolveURL in interface SourceUrlResolver

Parameters:

demo - The TabbedDemo view requesting the URL resolution.

annotatedClass - The class that is annotated with DemoSource.

annotation - The DemoSource annotation providing source metadata.

Returns:

An Optional containing the resolved URL if available, otherwise an empty Optional.

resolveURL

public Optional<String> resolveURL(Class<? extends TabbedDemo> viewClass,
 Class<?> annotatedClass,
 DemoSource annotation)