xref: /external/droiddriver/src/com/google/android/droiddriver/finders/ByXPath.java

/*
 * Copyright (C) 2013 DroidDriver committers
 *
 * 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.android.droiddriver.matchers;

import com.google.android.droiddriver.exceptions.DroidDriverException;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;

/**
 * Find matching UiElement by XPath.
 */
public class ByXPath implements Matcher {
  private static final XPath XPATH_COMPILER = XPathFactory.newInstance().newXPath();
  private final String xPathString;
  private final XPathExpression xPathExpression;

  protected ByXPath(String xPathString) {
    this.xPathString = Preconditions.checkNotNull(xPathString);
    try {
      xPathExpression = XPATH_COMPILER.compile(xPathString);
    } catch (XPathExpressionException e) {
      throw new DroidDriverException(e);
    }
  }

  @Override
  public String toString() {
    return Objects.toStringHelper(this).addValue(xPathString).toString();
  }

  public XPathExpression getXPathExpression() {
    return xPathExpression;
  }

  public String getXPathString() {
    return xPathString;
  }
}