platform/lang-api/src/com/intellij/psi/codeStyle/arrangement/std/StdArrangementTokenType.java

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * 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.intellij.psi.codeStyle.arrangement.std;

import org.jetbrains.annotations.NotNull;

/**
 * Type of {@link StdArrangementSettingsToken}. Defines UI role used to display the token. Used to differentiate between semantically
 * different tokens when constructing matchers.
 * (see {@link com.intellij.psi.codeStyle.arrangement.match.StdArrangementEntryMatcher.StdMatcherBuilderImpl}).
 *
 * @author Roman.Shein
 * Date: 31.07.13
 */
public class StdArrangementTokenType {
  @NotNull private final StdArrangementTokenUiRole myUiRole;
  @NotNull private final String myId;

  public StdArrangementTokenType(@NotNull StdArrangementTokenUiRole uiRole, @NotNull String id) {
    myUiRole = uiRole;
    myId = id;
  }

  @NotNull public StdArrangementTokenUiRole getUiRole() {
    return myUiRole;
  }

  public boolean is(ArrangementSettingsToken token) {
    return token instanceof StdArrangementSettingsToken && this.equals(((StdArrangementSettingsToken)token).getTokenType());
  }

  @Override
  public int hashCode() {
    return myId.hashCode();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {return true;}
    if (o == null || !(o instanceof StdArrangementTokenType)) {
      return false;
    }
    StdArrangementTokenType oType = (StdArrangementTokenType) o;
    return oType.myId.equals(myId) && myUiRole == oType.myUiRole;
  }

  public static final String GENERAL_ID = "GENERAL";
  public static final String GROUPING_ID = "GROUPING";
  public static final String MODIFIER_ID = "MODIFIER";
  public static final String REG_EXP_ID = "REG_EXP";
  public static final String ENTRY_TYPE_ID = "ENTRY_TYPE";
  public static final String ORDER_ID = "ORDER";

  public static final StdArrangementTokenType GENERAL = new StdArrangementTokenType(StdArrangementTokenUiRole.LABEL, GENERAL_ID);
  public static final StdArrangementTokenType GROUPING = new StdArrangementTokenType(StdArrangementTokenUiRole.CHECKBOX, GROUPING_ID);
  public static final StdArrangementTokenType MODIFIER = new StdArrangementTokenType(StdArrangementTokenUiRole.BULB, MODIFIER_ID);
  public static final StdArrangementTokenType REG_EXP = new StdArrangementTokenType(StdArrangementTokenUiRole.TEXT_FIELD, REG_EXP_ID);
  public static final StdArrangementTokenType ENTRY_TYPE = new StdArrangementTokenType(StdArrangementTokenUiRole.BULB, ENTRY_TYPE_ID);
  public static final StdArrangementTokenType ORDER = new StdArrangementTokenType(StdArrangementTokenUiRole.COMBO_BOX, ORDER_ID);
}