java source code of ReferenceAvroType

/*
 * Copyright 2013 Nokia Corporation
 *
 * 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.nokia.util.avro.schemagen;

import com.nokia.util.avro.types.AvroPrimitive;
import com.nokia.util.avro.types.AvroRecord;
import com.nokia.util.avro.types.AvroType;
import org.codehaus.jackson.annotate.JsonValue;

import java.util.Collections;
import java.util.Set;


/**
 * @author Ben Fagin (Nokia)
 * @version 02-01-2012
 * 
 * A special type used to denote a JAXB reference, which is generally in the form of a String.
 */
public class ReferenceAvroType extends AvroType {
	public static final String name = "_Reference";
	public final String namespace;
	
	public ReferenceAvroType(String namespace) {
		this.namespace = namespace;
	}
	
	
	@JsonValue
	public String jsonValue() {
		return namespace + "." + name;
	}

	@Override
	public Set<String> getDependencies() {
		return Collections.emptySet();
	}

	public static AvroRecord getSchema(String namespace) {
		AvroType type = AvroPrimitive.PrimitiveType.STRING.newInstance();
		AvroRecord record = new AvroRecord();
		record.addField("id", type, type.getDefaultValue());
		record.setDocs("A reference to an entity, similar to the IDREF object in XML schemas");
		record.name = name;
		record.namespace = namespace;

		return record;
	}
}