com.feilong.context.ReturnResultBuilder Maven / Gradle / Ivy

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

feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.

There is a newer version: 4.0.8

Show newest version

/*
 * Copyright (C) 2008 feilong
 *
 * 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.feilong.context;

import com.feilong.core.Validate;

/**
 * {@link ReturnResult} 一些工具类.
 *
 * @author feilong
 * @since 1.11.0
 */
public final class ReturnResultBuilder{

    /** Don't let anyone instantiate this class. */
    private ReturnResultBuilder(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

    //---------------------------------------------------------------------

    /**
     * 构造带statusCode 的失败结果.
     * 
     * 示例:
     * 
     * 
     * 
     * 
     * 对于以下代码:
     * 
     * 
     *      * 
     * ReturnResult returnResult = new ReturnResult();
     * 
     * returnResult.setResult(false);
     * returnResult.setStatusCode("member.email.error");
     * return returnResult;
     * 
     * 
     * 
     * 此时可以重构成:
     * 
     *      * return ReturnResultBuilder.buildFailureResult("member.email.error");
     * 
     * 
     * 
     *
     * @param statusCode
     *            返回状态码
     * @return 如果 statusCode 是null,抛出 {@link NullPointerException}

     *         如果 statusCode 是blank,抛出 {@link IllegalArgumentException}

     */
    public static ReturnResult