org.wisepersist.settings.env.EnvConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wisepersist-settings Show documentation

WisePersist AppConfig is a utility module which simplifies application configurations against different environments - test, dev, stage and prod.

The newest version!

/*
 * Copyright (c) 2016 WisePersist.org
 *
 * 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 org.wisepersist.settings.env;

/**
 * This interface contains methods to identify the current environment.
 *
 * @author [email protected]
 */
public interface EnvConfig {

  /**
   * To get the environment type set on object creation.
   *
   * @return EnvironmentType of environment info.
   */
  EnvType getEnv();

  /**
   * True is on production, otherwise false.
   *
   * @return Boolean value of evaluation.
   */
  boolean isProd();

  /**
   * True is on stage, otherwise false.
   *
   * @return Boolean value of evaluation.
   */
  boolean isStage();

  /**
   * True is on dev, otherwise false.
   *
   * @return Boolean value of evaluation.
   */
  boolean isDev();

  /**
   * True is on test, otherwise false.
   *
   * @return Boolean value of evaluation.
   */
  boolean isTest();

}