/*
 * Copyright (C) 2023 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.android.internal.vibrator.persistence;

import android.annotation.NonNull;

/**
 * Creates a {@link XmlSerializedVibration} instance representing a vibration.
 *
 * @param <T> The vibration type that will be serialized.
 * @see XmlSerializedVibration
 * @hide
 */
@FunctionalInterface
public interface XmlSerializer<T> {

    /**
     * Creates a serialized representation of the input {@code vibration}.
     *
     * @param vibration The vibration to be serialized
     * @return The serialized representation of the input vibration
     * @throws XmlSerializerException If the input vibration cannot be serialized
     */
    @NonNull
    XmlSerializedVibration<T> serialize(@NonNull T vibration) throws XmlSerializerException;
}