org.shredzone.flattr4j.web.builder.LoaderBuilder Maven / Gradle / Ivy
/*
* flattr4j - A Java library for Flattr
*
* Copyright (C) 2011 Richard "Shred" Körber
* http://flattr4j.shredzone.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License / GNU Lesser
* General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
package org.shredzone.flattr4j.web.builder;
import org.shredzone.flattr4j.model.Category;
import org.shredzone.flattr4j.model.CategoryId;
import org.shredzone.flattr4j.model.Language;
import org.shredzone.flattr4j.model.LanguageId;
import org.shredzone.flattr4j.model.User;
import org.shredzone.flattr4j.model.UserId;
import org.shredzone.flattr4j.web.ButtonType;
/**
* Builds the JavaScript loader for the Flattr API.
*
* The builder uses sensible default settings that can be changed by using its methods.
* All methods return a reference to the builder itself, so method calls can be
* daisy-chained.
*
* Example: String loader = new LoaderBuilder().uid("123456").toString();
*
* @author Richard "Shred" Körber
*/
public class LoaderBuilder {
private String baseUrl = "http://api.flattr.com";
private String version = "0.6";
private boolean bare = false;
private boolean automatic = true;
private boolean https = false;
private Boolean popout = null;
private String uid = null;
private ButtonType type = null;
private String language = null;
private String category = null;
private String prefix = null;
/**
* Sets the base URL of the Flattr API. Defaults to "http://api.flattr.com". Do not
* change unless you know what you are doing.
*
* @param baseUrl
* New Flattr API url to be used
*/
public LoaderBuilder baseUrl(String baseUrl) {
this.baseUrl = baseUrl;
return this;
}
/**
* Sets the API version to be used. Usually there is no need to change the default
* value, so do not change unless you know what you are doing.
*
* @param version
* API version to be used (e.g. "0.6")
*/
public LoaderBuilder version(String version) {
this.version = version;
return this;
}
/**
* The builder will return a bare javascript, without an enclosing <script> tag.
*/
public LoaderBuilder bare() {
bare = true;
return this;
}
/**
* The Flattr API will not be initialized automatically, but requires a manual
* invocation of FlattrLoader.setup(). By default, the API is initialized
* automatically on onload.
*/
public LoaderBuilder manual() {
automatic = false;
return this;
}
/**
* Sets whether to override the popout default and show a popout when hovering with
* the mouse over the button.
*
* @param popout
* {@code true}: always show a popout, {@code false}: never show a popout
* @since 2.2
*/
public LoaderBuilder popout(boolean popout) {
this.popout = popout;
return this;
}
/**
* Use https for loading Flattr resources (javascripts, images etc). By default http
* is used.
*/
public LoaderBuilder https() {
https = true;
return this;
}
/**
* Sets the default {@link User}.
*
* @param user
* {@link UserId}
*/
public LoaderBuilder user(UserId user) {
this.uid = user.getUserId();
return this;
}
/**
* Sets the default button type to be used.
*
* @param type
* {@link ButtonType} to be used
*/
public LoaderBuilder button(ButtonType type) {
this.type = type;
return this;
}
/**
* Sets the default {@link Language}.
*
* @param language
* Default {@link LanguageId}
*/
public LoaderBuilder language(LanguageId language) {
this.language = language.getLanguageId();
return this;
}
/**
* Sets the default {@link Category}.
*
* @param category
* Default {@link CategoryId}
*/
public LoaderBuilder category(CategoryId category) {
this.category = category.getCategoryId();
return this;
}
/**
* Sets a HTML5 key prefix. By default "data-flattr" is used.
*
* @param prefix
* HTML5 key prefix. The string must start with "data-"
*/
public LoaderBuilder prefix(String prefix) {
if (!prefix.startsWith("data-")) {
throw new IllegalArgumentException("prefix must start with \"data-\"");
}
this.prefix = prefix;
return this;
}
/**
* Builds a loader script of the current setup.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
char separator = '?';
if (!bare) {
sb.append("");
}
return sb.toString();
}
}