sdks/android/src/main/java/org/apache/usergrid/android/sdk/entities/Device.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.usergrid.android.sdk.entities;

import static org.apache.usergrid.android.sdk.utils.JsonUtils.setStringProperty;
import static com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion.NON_NULL;

import java.util.List;

import org.apache.usergrid.android.sdk.UGClient;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

/**
 * Models a 'device' entity as a local object.
 *
 */
public class Device extends Entity {

	public final static String ENTITY_TYPE = "device";

	public final static String PROPERTY_NAME = "name";

	/**
	 * Checks if the provided type equals 'device'.
	 *
	 * @return  Boolean true/false
	 */
	public static boolean isSameType(String type) {
		return type.equals(ENTITY_TYPE);
	}

	/**
	 * Default constructor for the Device object. Sets 'type'
	 * property to 'device'.
	 */
	public Device() {
		setType(ENTITY_TYPE);
	}
	
	/**
	 * Constructs the Device object with a UGClient. Sets 'type'
	 * property to 'device'.
	 */
	public Device(UGClient client) {
		super(client);
		setType(ENTITY_TYPE);
	}

	/**
	 * Constructs a Device object from an Entity object. If the Entity
	 * has a 'type' property with a value other than 'device', the value
	 * will be overwritten.
	 */
	public Device(Entity entity) {
		super(entity.getUGClient());
		properties = entity.properties;
		setType(ENTITY_TYPE);
	}

	/**
	 * Returns the type of the Device object. Should always be 'device'.
	 *
	 * @return the String 'device'
	 */
	@Override
	@JsonIgnore
	public String getNativeType() {
		return ENTITY_TYPE;
	}

	/**
	 * Gets the current set of property names in the Device and adds
	 * the 'name' property.
	 *
	 * @return a List object of all properties in the Device
	 */
	@Override
	@JsonIgnore
	public List<String> getPropertyNames() {
		List<String> properties = super.getPropertyNames();
		properties.add(PROPERTY_NAME);
		return properties;
	}

	/**
	 * Gets the value of the 'name' property of the Device.
	 *
	 * @return the value of the 'name' property
	 */
	@JsonSerialize(include = NON_NULL)
	public String getName() {
		return getStringProperty(PROPERTY_NAME);
	}

	/**
	 * Sets the value of the 'name' property of the Device.
	 *
	 * @param  name  the value of the 'name' property
	 */
	public void setName(String name) {
		setStringProperty(properties, PROPERTY_NAME, name);
	}

}