RealFont.java

/**
 * Get more info at : www.jrebirth.org .
 * Copyright JRebirth.org © 2011-2013
 * Contact : sebastien.bordes@jrebirth.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jrebirth.af.core.resource.font;

import java.util.Arrays;
import java.util.List;

import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;

import org.jrebirth.af.api.resource.font.FontExtension;
import org.jrebirth.af.api.resource.font.FontName;
import org.jrebirth.af.core.resource.provided.JRebirthParameters;

/**
 * The interface <strong>RealFont</strong> is used to create a font according to its name.
 *
 * @author Sébastien Bordes
 */
public class RealFont extends AbstractBaseFont {

    /** The flag used to skip the fontsFolder prefix addition ({@link JRebirthParameters#FONT_FOLDER}). */
    private final transient BooleanProperty skipFontsFolderProperty = new SimpleBooleanProperty();

    /**
     * Default Constructor.
     *
     * @param name the font name
     * @param size the default font size
     * @param extension the font extension
     * @param skipFontsFolder skip default fonts folder search
     */
    public RealFont(final FontName name, final double size, final FontExtension extension, final boolean skipFontsFolder) {
        super(name, size, extension);
        this.skipFontsFolderProperty.set(skipFontsFolder);
    }

    /**
     * Default Constructor.
     *
     * @param name the font name
     * @param size the default font size
     * @param extension the font extension
     */
    public RealFont(final FontName name, final double size, final FontExtension extension) {
        this(name, size, extension, false);
    }

    /**
     * Default Constructor.
     *
     * @param name the font name
     * @param size the default font size
     * @param skipFontsFolder skip default fonts folder search
     */
    public RealFont(final FontName name, final double size, final boolean skipFontsFolder) {
        super(name, size);
        this.skipFontsFolderProperty.set(skipFontsFolder);
    }

    /**
     * Default Constructor.
     *
     * @param name the font name
     * @param size the default font size
     * @param extension the font extension
     */
    public RealFont(final FontName name, final double size) {
        this(name, size, false);
    }

    /**
     * Return the skipFontsFolder flag.
     *
     * @return the skipFontsFolder flag
     */
    public boolean skipFontsFolder() {
        return this.skipFontsFolderProperty.get();
    }

    /**
     * Return the skipFontsFolderProperty property.
     *
     * @return the skipFontsFolderProperty property
     */
    public BooleanProperty skipFontsFolderProperty() {
        return this.skipFontsFolderProperty;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void parse(final String... parameters) {
        if (parameters.length >= 1) {
            nameProperty().set(new CustomFontName(parameters[0]));
        }
        if (parameters.length >= 2) {
            sizeProperty().set(readDouble(parameters[1], 1.0, 1000.0));
        }
        if (parameters.length == 3) {
            skipFontsFolderProperty().set(readBoolean(parameters[2]));
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected List<? extends Object> getFieldValues() {
        return Arrays.asList(name().toString(), size(), skipFontsFolder());
    }

}