ISearcher.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

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.google.security.zynamics.binnavi.Gui.Debug.SearchMemory;

import javax.swing.JFormattedTextField.AbstractFormatterFactory;

/**
 * Interface that must be implemented by all classes that are used as search data types in the
 * search dialog.
 */
public interface ISearcher {
  /**
   * Returns the name of the alternative display field.
   *
   * @return The name of the alternative display field.
   */
  String getAlternativeName();

  /**
   * Returns the alternative display string of the entered text.
   *
   * @param text The entered text.
   *
   * @return The alternative display string of the entered text.
   */
  String getAlternativeString(String text);

  /**
   * Returns the formatter factory that decides about valid inputs for the search data type.
   *
   * @return A valid formatter factory or null.
   */
  AbstractFormatterFactory getFormatterFactory();

  /**
   * Converts the entered text into searchable bytes.
   *
   * @param text The entered text.
   *
   * @return The searchable byte array.
   */
  byte[] getSearchData(String text);
}