Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b006c095 authored by Yeabkal Wubshit's avatar Yeabkal Wubshit Committed by Android (Google) Code Review
Browse files

Merge "Change <vibration> to <vibration-effect>" into main

parents 9512dc28 8969182e
Loading
Loading
Loading
Loading
+18 −18
Original line number Diff line number Diff line
@@ -56,9 +56,9 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <predefined-effect name="click" />
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
@@ -66,7 +66,7 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <waveform-effect>
 *         <waveform-entry amplitude="default" durationMs="10" />
 *         <waveform-entry amplitude="0" durationMs="10" />
@@ -77,7 +77,7 @@ import java.util.List;
 *           <waveform-entry amplitude="255" durationMs="20" />
 *         </repeating>
 *       </waveform-effect>
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
@@ -85,31 +85,31 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <primitive-effect name="click" />
 *       <primitive-effect name="slow_rise" scale="0.8" />
 *       <primitive-effect name="quick_fall" delayMs="50" />
 *       <primitive-effect name="tick" scale="0.5" delayMs="100" />
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
 * <p>When the root element represents a selection list of vibration effects, the root tag should be
 * a <vibration-select> tag. The root element should contain a list of vibration serializations.
 * Each vibration within the root-element should follow the format discussed for the <vibration> tag
 * above. See example below:
 * Each vibration within the root-element should follow the format discussed for the
 * <vibration-effect> tag above. See example below:
 *
 * <pre>
 *   {@code
 *     <vibration-select>
 *       <vibration>
 *       <vibration-effect>
 *         <predefined-effect name="click" />
 *       </vibration>
 *       <vibration>
 *       </vibration-effect>
 *       <vibration-effect>
 *         <waveform-effect>
 *           <waveform-entry amplitude="default" durationMs="10" />
 *         </waveform-effect>
 *       </vibration>
 *       </vibration-effect>
 *     </vibration-select>
 *   }
 * </pre>
@@ -262,12 +262,12 @@ public final class VibrationXmlParser {
     * {@link ParsedVibration}.
     *
     * <p>Same as {@link #parseDocument(Reader, int)}, but, instead of parsing the full XML content,
     * it takes a parser that points to either a <vibration> or a <vibration-select> start tag. No
     * other parser position, including start of document, is considered valid.
     * it takes a parser that points to either a <vibration-effect> or a <vibration-select> start
     * tag. No other parser position, including start of document, is considered valid.
     *
     * <p>This method parses until an end "vibration" or "vibration-select" tag (depending on the
     * start tag found at the start of parsing). After a successful parsing, the parser will point
     * to the end tag.
     * <p>This method parses until an end "vibration-effect" or "vibration-select" tag (depending
     * on the start tag found at the start of parsing). After a successful parsing, the parser
     * will point to the end tag.
     *
     * @throws IOException error parsing from given {@link TypedXmlPullParser}.
     * @throws VibrationXmlParserException if the XML tag cannot be parsed into a
@@ -308,7 +308,7 @@ public final class VibrationXmlParser {

        String tagName = parser.getName();
        switch(tagName) {
            case XmlConstants.TAG_VIBRATION:
            case XmlConstants.TAG_VIBRATION_EFFECT:
                return new ParsedVibration(parseVibrationEffectInternal(parser, flags));
            case XmlConstants.TAG_VIBRATION_SELECT:
                return parseVibrationSelectInternal(parser, flags);
+2 −2
Original line number Diff line number Diff line
@@ -65,9 +65,9 @@ final class SerializedVibrationEffect implements XmlSerializedVibration<Vibratio
    @Override
    public void write(@NonNull TypedXmlSerializer serializer)
            throws IOException {
        serializer.startTag(XmlConstants.NAMESPACE, XmlConstants.TAG_VIBRATION);
        serializer.startTag(XmlConstants.NAMESPACE, XmlConstants.TAG_VIBRATION_EFFECT);
        writeContent(serializer);
        serializer.endTag(XmlConstants.NAMESPACE, XmlConstants.TAG_VIBRATION);
        serializer.endTag(XmlConstants.NAMESPACE, XmlConstants.TAG_VIBRATION_EFFECT);
    }

    @Override
+8 −8
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ package com.android.internal.vibrator.persistence;

import static com.android.internal.vibrator.persistence.XmlConstants.TAG_PREDEFINED_EFFECT;
import static com.android.internal.vibrator.persistence.XmlConstants.TAG_PRIMITIVE_EFFECT;
import static com.android.internal.vibrator.persistence.XmlConstants.TAG_VIBRATION;
import static com.android.internal.vibrator.persistence.XmlConstants.TAG_VIBRATION_EFFECT;
import static com.android.internal.vibrator.persistence.XmlConstants.TAG_WAVEFORM_EFFECT;

import android.annotation.NonNull;
@@ -44,9 +44,9 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <predefined-effect name="click" />
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
@@ -54,7 +54,7 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <waveform-effect>
 *         <waveform-entry amplitude="default" durationMs="10" />
 *         <waveform-entry amplitude="0" durationMs="10" />
@@ -65,7 +65,7 @@ import java.util.List;
 *           <waveform-entry amplitude="255" durationMs="20" />
 *         </repeating>
 *       </waveform-effect>
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
@@ -73,10 +73,10 @@ import java.util.List;
 *
 * <pre>
 *   {@code
 *     <vibration>
 *     <vibration-effect>
 *       <primitive-effect name="click" />
 *       <primitive-effect name="tick" scale="0.5" delayMs="100" />
 *     </vibration>
 *     </vibration-effect>
 *   }
 * </pre>
 *
@@ -94,7 +94,7 @@ public class VibrationEffectXmlParser {
    public static XmlSerializedVibration<VibrationEffect> parseTag(
            @NonNull TypedXmlPullParser parser, @XmlConstants.Flags int flags)
            throws XmlParserException, IOException {
        XmlValidator.checkStartTag(parser, TAG_VIBRATION);
        XmlValidator.checkStartTag(parser, TAG_VIBRATION_EFFECT);
        XmlValidator.checkTagHasNoUnexpectedAttributes(parser);

        return parseVibrationContent(parser, flags);
+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ public final class XmlConstants {

    public static final String NAMESPACE = null;

    public static final String TAG_VIBRATION = "vibration";
    public static final String TAG_VIBRATION_EFFECT = "vibration-effect";
    public static final String TAG_VIBRATION_SELECT = "vibration-select";

    public static final String TAG_PREDEFINED_EFFECT = "predefined-effect";
+2 −1
Original line number Diff line number Diff line
@@ -54,7 +54,8 @@ public interface XmlSerializedVibration<T> {
     *
     * <p>This allows the same serialized representation of a vibration to be used in different
     * contexts (e.g. a {@link android.os.VibrationEffect} can be written into any of the tags
     * {@code <vibration>}, {@code <parallel-vibration>} or {@code <vibration vibratorId="0">}).
     * {@code <vibration-effect>}, {@code <parallel-vibration-effect>}
     * or {@code <vibration-effect vibratorId="0">}).
     *
     * @param serializer The output XML serializer where the vibration will be written
     */
Loading