DefaultPropertyTester.java

/*
 * Copyright (c) 2011, 2012, 2015 Eike Stepper (Berlin, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.net4j.util.properties;

import org.eclipse.core.expressions.PropertyTester;

import java.util.List;

/**
 * Tests properties of receiver objects against expected values.
 *
 * @author Eike Stepper
 * @since 3.2
 */
public class DefaultPropertyTester<RECEIVER> extends PropertyTester implements IProperties<RECEIVER>
{
  private final String namespace;

  private final IProperties<RECEIVER> properties;

  public DefaultPropertyTester(String namespace, IProperties<RECEIVER> properties)
  {
    this.namespace = namespace;
    this.properties = properties;
  }

  public final String getNamespace()
  {
    return namespace;
  }

  public Class<RECEIVER> getReceiverType()
  {
    return properties.getReceiverType();
  }

  public Property<RECEIVER> getProperty(String name)
  {
    return properties.getProperty(name);
  }

  public List<Property<RECEIVER>> getProperties()
  {
    return properties.getProperties();
  }

  public void add(Property<RECEIVER> property)
  {
    properties.add(property);
  }

  public boolean test(Object receiver, String propertyName, Object[] args, Object expectedValue)
  {
    Property<RECEIVER> property = getProperty(propertyName);
    if (property == null)
    {
      return false;
    }

    if (!getReceiverType().isInstance(receiver))
    {
      receiver = convertReceiver(receiver);
    }

    @SuppressWarnings("unchecked")
    RECEIVER typed = (RECEIVER)receiver;
    return property.testValue(typed, args, expectedValue);
  }

  /**
   * @since 3.5
   */
  protected RECEIVER convertReceiver(Object receiver)
  {
    return null;
  }

  /**
   * @since 3.5
   */
  protected String getReceiverTypeName()
  {
    return getReceiverType().getName();
  }

  public void dumpContributionMarkup()
  {
    System.out.println("   <extension point=\"org.eclipse.core.expressions.propertyTesters\">");
    System.out.println("      <propertyTester");
    System.out.println("         id=\"" + getNamespace() + ".properties\"");
    System.out.println("         type=\"" + getReceiverTypeName() + "\"");
    System.out.println("         namespace=\"" + getNamespace() + "\"");
    System.out.print("         properties=\"");

    boolean first = true;
    for (Property<RECEIVER> property : getProperties())
    {
      if (first)
      {
        first = false;
      }
      else
      {
        System.out.print(",");
      }

      System.out.print(property.getName());
    }

    System.out.println("\"");
    System.out.println("         class=\"" + getClass().getName() + "\"/>");
    System.out.println("   </extension>");

  }
}