com.webfirmframework.wffweb.wffbm.data.WffBMData Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wffweb Show documentation

A java framework to develop web applications

There is a newer version: 12.0.2

/*
 * Copyright 2014-2020 Web Firm Framework
 *
 * 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.webfirmframework.wffweb.wffbm.data;

import java.io.UnsupportedEncodingException;

/**
 * @author WFF
 * @since 2.1.8
 */
public interface WffBMData extends WffData {

    /**
     * @return the BMType
     * @since 2.1.8
     * @author WFF
     */
    public abstract BMType getBMType();

    /**
     * NB: use buildBytes instead of this method.
     *
     * @param outer
     * @return the bytes representation of the object
     * @throws UnsupportedEncodingException
     *                                          throwing this exception will be
     *                                          removed in future version
     *                                          because its internal
     *                                          implementation will never make
     *                                          this exception due to the code
     *                                          changes since 3.0.1.
     * @since 2.1.8
     * @author WFF
     * @deprecated building bytes implementation doesn't throw
     *             UnsupportedEncodingException so deprecated this method. The
     *             same goal can be achieved using buildBytes method.
     */
    @Deprecated
    public abstract byte[] build(boolean outer)
            throws UnsupportedEncodingException;

    /**
     *
     * @param outer
     * @return the bytes representation of the object
     *
     * @since 3.0.2
     * @author WFF
     */
    public abstract byte[] buildBytes(boolean outer);

}