org.apache.fop.tools.fontlist.FontSpec Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fop Show documentation
Show all versions of fop Show documentation
Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/* $Id: FontSpec.java 1616312 2014-08-06 19:19:31Z gadams $ */
package org.apache.fop.tools.fontlist;
import java.util.Collection;
import java.util.Collections;
import java.util.SortedSet;
import java.util.TreeSet;
import org.apache.fop.fonts.FontMetrics;
import org.apache.fop.fonts.FontTriplet;
/**
* Represents a font with information on how it can be used from XSL-FO.
*/
public class FontSpec implements Comparable {
private String key;
private FontMetrics metrics;
private SortedSet familyNames = new TreeSet();
private Collection triplets = new TreeSet();
/**
* Creates a new font spec.
* @param key the internal font key
* @param metrics the font metrics
*/
public FontSpec(String key, FontMetrics metrics) {
this.key = key;
this.metrics = metrics;
}
/**
* Adds font family names.
* @param names the names
*/
public void addFamilyNames(Collection names) {
this.familyNames.addAll(names);
}
/**
* Adds a font triplet.
* @param triplet the font triplet
*/
public void addTriplet(FontTriplet triplet) {
this.triplets.add(triplet);
}
/**
* Returns the font family names.
* @return the font family names
*/
public SortedSet getFamilyNames() {
return Collections.unmodifiableSortedSet(this.familyNames);
}
/**
* Returns the font triplets.
* @return the font triplets
*/
public Collection getTriplets() {
return Collections.unmodifiableCollection(this.triplets);
}
/**
* Returns the internal font key.
* @return the internal font key
*/
public String getKey() {
return this.key;
}
/**
* Returns the font metrics.
* @return the font metrics
*/
public FontMetrics getFontMetrics() {
return this.metrics;
}
@Override
public int hashCode() {
return metrics.getFullName().hashCode();
}
@Override
public boolean equals(Object o) {
if (o instanceof FontSpec) {
FontSpec other = (FontSpec)o;
return metrics.getFullName().equals(other.metrics.getFullName());
} else {
return false;
}
}
@Override
public int compareTo(Object o) {
if (o instanceof FontSpec) {
FontSpec other = (FontSpec)o;
return metrics.getFullName().compareTo(other.metrics.getFullName());
} else {
return 1;
}
}
}