/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.ignite.internal.tostring;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Class, field, or method with this annotation <b>should</b> be included in {@code toString()} output with a custom representation of the
 * instance in a string.
 *
 * @see Stringifier
 * @see S
 */
@Documented
@Retention(RUNTIME)
@Target({FIELD, TYPE, METHOD})
public @interface IgniteStringifier {
    /** Instance name to use when converting to a string, defaulting to the class, field, or method name. */
    String name() default "";

    /** Class that will convert an instance to a string allows to override {@link Object#toString}. */
    Class<? extends Stringifier<?>> value();
}
