SerializeAs.java

Go to the documentation of this file.

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Inc.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * 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 org.omg.dds.type;

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



@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {
        ElementType.TYPE,       // for specifying structure vs. union
        ElementType.ANNOTATION_TYPE,    // for indicating DDS annotations
        ElementType.FIELD,      // for primitives, collections, etc.
        ElementType.METHOD      // JavaBean property: like field, but doc only
    })
public @interface SerializeAs {
    public TypeKind value();

    public TypeKind collectionElementKind() default TypeKind.NO_TYPE;

    public TypeKind mapKeyElementKind() default TypeKind.NO_TYPE;

    public long[] bound() default { /* empty */ };
}