/*
 *
 * Copyright (c) 2013 - 2017 Lijun Liao
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 *
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * THE AUTHOR LIJUN LIAO. LIJUN LIAO DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the XiPKI software without
 * disclosing the source code of your own applications.
 *
 * For more information, please contact Lijun Liao at this
 * address: lijun.liao@gmail.com
 */

package org.xipki.pki.ca.dbtool.xmlio;

import javax.xml.stream.XMLStreamException;

import org.eclipse.jdt.annotation.NonNull;
import org.xipki.commons.common.util.StringUtil;

/**
 * @author Lijun Liao
 * @since 2.0.0
 */

public abstract class DbDataObject {

    protected DbDataObject() {
    }

    protected void assertNotBlank(final String name, final String value)
            throws InvalidDataObjectException {
        if (StringUtil.isBlank(value)) {
            throw new InvalidDataObjectException(name + " must not be blank");
        }
    }

    protected void assertNotNull(final String name, final Object value)
            throws InvalidDataObjectException {
        if (value == null) {
            throw new InvalidDataObjectException(name + " must not be null");
        }
    }

    protected static void writeIfNotNull(final DbiXmlWriter writer, final String tag,
            final Object value) throws XMLStreamException, InvalidDataObjectException {
        if (value == null) {
            return;
        }

        String valueS;
        if (value instanceof String) {
            valueS = (String) value;
        } else if (value instanceof Number) {
            valueS = value.toString();
        } else if (value instanceof Boolean) {
            valueS = value.toString();
        } else {
            throw new InvalidDataObjectException("value is not a String or Number");
        }

        writer.writeElement(tag, valueS);
    }

    public abstract void validate() throws InvalidDataObjectException;

    public abstract void writeTo(@NonNull DbiXmlWriter os)
            throws InvalidDataObjectException, XMLStreamException;

}