com.helger.json.valueserializer.IJsonValueSerializerRegistry Maven / Gradle / Ivy

/**
 * Copyright (C) 2014-2020 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.json.valueserializer;

import javax.annotation.Nonnull;

/**
 * This is the callback interface implemented by
 * {@link JsonValueSerializerRegistry} for registration via the SPI interface.
 *
 * @author Philip Helger
 */
public interface IJsonValueSerializerRegistry
{
  /**
   * Register the value serializer for a certain class.
   *
   * @param aClass
   *        The class to be registered. May not be null.
   * @param aValueSerializer
   *        The value serializer. May not be null.
   * @throws IllegalArgumentException
   *         If a value serializer for the specified class is already
   *         registered.
   */
  void registerJsonValueSerializer (@Nonnull Class  aClass, @Nonnull IJsonValueSerializer aValueSerializer);
}