Font

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getAxes

public FontVariationAxis[] getAxes ()

Get a font variation settings associated with this font

getBuffer

public ByteBuffer getBuffer ()

Returns a font file buffer. Duplicate before reading values by ByteBuffer.duplicate() for avoiding unexpected reading position sharing.

getFile

public File getFile ()

Returns a file path of this font. This returns null if this font is not created from regular file.

getGlyphBounds

public float getGlyphBounds (int glyphId, 
                Paint paint, 
                RectF outBoundingBox)

Retrieve the glyph horizontal advance and bounding box. Note that Typeface in Paint is ignored.

getLocaleList

public LocaleList getLocaleList ()

Get a locale list of this font. This is always empty if this font is not a system font.

getMetrics

public void getMetrics (Paint paint, 
                Paint.FontMetrics outMetrics)

Retrieve the font metrics information. Note that Typeface in Paint is ignored.

getSourceIdentifier

public int getSourceIdentifier ()

Returns the unique ID of the source font data. You can use this identifier as a key of the cache or checking if two fonts can be interpolated with font variation settings.

 
   // Following three Fonts, fontA, fontB, fontC have the same identifier.
   Font fontA = new Font.Builder("/path/to/font").build();
   Font fontB = new Font.Builder(fontA).setTtcIndex(1).build();
   Font fontC = new Font.Builder(fontB).setFontVariationSettings("'wght' 700).build();

   // Following fontD has the different identifier from above three.
   Font fontD = new Font.Builder("/path/to/another/font").build();

   // Following fontE has different identifier from above four even the font path is the same.
   // To get the same identifier, please create new Font instance from existing fonts.
   Font fontE = new Font.Builder("/path/to/font").build();
 
 

 
   private LongSparseArray> mCache = new LongSparseArray<>();

   private Font getFontWeightVariation(Font font, int weight) {
       // Different collection index is treated as different font.
       long key = ((long) font.getSourceIdentifier()) << 32 | (long) font.getTtcIndex();

       SparseArray weightCache = mCache.get(key);
       if (weightCache == null) {
          weightCache = new SparseArray<>();
          mCache.put(key, weightCache);
       }

       Font cachedFont = weightCache.get(weight);
       if (cachedFont != null) {
         return cachedFont;
       }

       Font newFont = new Font.Builder(cachedFont)
           .setFontVariationSettings("'wght' " + weight);
           .build();

       weightCache.put(weight, newFont);
       return newFont;
   }