/*
 * 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.asterix.external.library.java.base;

import java.io.DataOutput;

import org.apache.asterix.om.base.ANull;
import org.apache.asterix.om.base.IAObject;
import org.apache.asterix.om.types.ATypeTag;
import org.apache.asterix.om.types.BuiltinType;
import org.apache.asterix.om.types.IAType;
import org.apache.hyracks.api.exceptions.HyracksDataException;

/*
 *  This class is necessary to be able to serialize null base
 *  in cases of setting "null" results
 *
 */
public final class JNull extends JObject {

    public final static JNull INSTANCE = new JNull();

    @Override
    public IAType getIAType() {
        return BuiltinType.ANULL;
    }

    @Override
    public IAObject getIAObject() {
        return ANull.NULL;
    }

    @Override
    public void setValueGeneric(Object o) {
        if (o != null) {
            throw new IllegalArgumentException("Not null");
        }
    }

    @Override
    public Object getValueGeneric() {
        return null;
    }

    @Override
    public void serialize(DataOutput dataOutput, boolean writeTypeTag) throws HyracksDataException {
        serializeTypeTag(writeTypeTag, dataOutput, ATypeTag.NULL);
    }

    @Override
    public void reset() {
        // no op for NULL
    }

}
