com.github.wasiqb.coteafs.appium.device.DeviceElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of appium Show documentation
Robust Automation Framework wrapped over Appium.
There is a newer version: 4.2.0
/**
 * Copyright (c) 2017, Wasiq Bhamla.
 *
 * 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.github.wasiqb.coteafs.appium.device;

import java.util.ArrayList;
import java.util.List;

import org.openqa.selenium.By;

/**
 * @author wasiq.bhamla
 * @since 25-Apr-2017 7:29:23 PM
 */
public class DeviceElement {
	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:34:42 PM
	 * @param name
	 * @return instance
	 */
	public static DeviceElement create (final String name) {
		return new DeviceElement (name);
	}

	private By							by;
	private final List 	childs;
	private int							index;
	private final String				name;
	private DeviceElement				parent;

	private DeviceElement (final String name) {
		this.childs = new ArrayList <> ();
		this.name = name;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:49:17 PM
	 * @return childs
	 */
	public List  childs () {
		return this.childs;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:45:09 PM
	 * @return index
	 */
	public int index () {
		return this.index;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:44:39 PM
	 * @param location
	 * @return instance
	 */
	public DeviceElement index (final int location) {
		this.index = location;
		return this;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:40:30 PM
	 * @return locator
	 */
	public By locator () {
		return this.by;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:35:06 PM
	 * @return name
	 */
	public String name () {
		return this.name;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:50:29 PM
	 * @return parent
	 */
	public DeviceElement parent () {
		return this.parent;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:49:46 PM
	 * @param elementParent
	 * @return instance
	 */
	public DeviceElement parent (final DeviceElement elementParent) {
		if (this.parent == null) {
			this.parent = elementParent;
		}
		if (!elementParent.childs ()
			.contains (this)) {
			elementParent.addChild (this);
		}
		return this;
	}

	/*
	 * (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString () {
		String line1 = "Name: %s";
		String line2 = "By: %s";
		String line4 = "Index: %d";
		String line3 = "Childs: %s";
		final StringBuilder sb = new StringBuilder (String.format (line1, this.name)).append ("\n");
		sb.append (String.format (line2, this.by))
			.append ("\n");
		sb.append (String.format (line4, this.index))
			.append ("\n");
		sb.append (String.format (line3, this.childs))
			.append ("\n");
		return sb.toString ();
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:36:32 PM
	 * @param findBy
	 * @return instance
	 */
	public DeviceElement using (final By findBy) {
		this.by = findBy;
		return this;
	}

	/**
	 * @author wasiq.bhamla
	 * @since 25-Apr-2017 7:48:31 PM
	 * @param androidElement
	 */
	private void addChild (final DeviceElement child) {
		this.childs.add (child);
		if (child.parent () == null || !child.parent ()
			.equals (this)) {
			child.parent (this);
		}
	}
}