content: /*
   * Copyright (C) 2020 The Android Open Source Project
   *
   * 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 com.google.android.exoplayer2.text.span;
  
  /**
   * A styling span for ruby text.
   *
   * <p>The text covered by this span is known as the "base text", and the ruby text is stored in
   * {@link #rubyText}.
   *
   * <p>More information on <a href="https://en.wikipedia.org/wiki/Ruby_character">ruby characters</a>
   * and <a href="https://developer.android.com/guide/topics/text/spans">span styling</a>.
   */
  // NOTE: There's no Android layout support for rubies, so this span currently doesn't extend any
  // styling superclasses (e.g. MetricAffectingSpan). The only way to render these rubies is to
  // extract the spans and do the layout manually.
  // TODO: Consider adding support for parenthetical text to be used when rendering doesn't support
  // rubies (e.g. HTML <rp> tag).
  public final class RubySpan implements LanguageFeatureSpan {
  
    /** The ruby text, i.e. the smaller explanatory characters. */
    public final String rubyText;
  
    /** The position of the ruby text relative to the base text. */
    public final @TextAnnotation.Position int position;
  
    public RubySpan(String rubyText, @TextAnnotation.Position int position) {
      this.rubyText = rubyText;
      this.position = position;
    }
  }
  