RecurrenceFrequency.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition 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 General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.common;

import org.projectforge.core.I18nEnum;

/**
 * Some objects need the attribute of a recurrence. This will be given as an interval.
 */
public enum RecurrenceFrequency implements I18nEnum
{
  YEARLY("yearly"), MONTHLY("monthly"), WEEKLY("weekly"), DAILY("daily"), HOURLY("hourly"), NONE("none");

  private String key;

  @Override
  public String getI18nKey()
  {
    return "common.recurrence.frequency." + key;
  }

  public String getUnitI18nKey()
  {
    switch (this) {
      case DAILY:
        return "plugins.teamcal.event.recurrence.customized.day";
      case WEEKLY:
        return "plugins.teamcal.event.recurrence.customized.week";
      case MONTHLY:
        return "plugins.teamcal.event.recurrence.customized.month";
      case YEARLY:
        return "plugins.teamcal.event.recurrence.customized.year";
      default:
        return null;
    }
  }

  /**
   * The key will be used e. g. for i18n.
   * @return
   */
  public String getKey()
  {
    return key;
  }

  RecurrenceFrequency(final String key)
  {
    this.key = key;
  }

  public boolean isIn(final RecurrenceFrequency... recurrance)
  {
    for (final RecurrenceFrequency rc : recurrance) {
      if (this == rc) {
        return true;
      }
    }
    return false;
  }
}