atom.ws.model.IntentTokenConverter Maven / Gradle / Ivy
/*
* Copyright © 2015 Geeoz, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Geeoz Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Geeoz Software is supplied to you by Geeoz in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Geeoz Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Geeoz Software.
*
* Neither the name, trademarks, service marks or logos of Geeoz may be used
* to endorse or promote products derived from the Geeoz Software without
* specific prior written permission from Geeoz.
*
* The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.geeoz.com/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Geeoz and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Geeoz and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Geeoz or visit www.geeoz.com if you need additional
* information or have any questions.
*/
package atom.ws.model;
import atom.content.Intent;
import java.util.List;
/**
* Intent token converter. Helps to convert {@link atom.content.Intent}
* into history token and back.
*
* History token should be matched to following structure:
* #!/category/category?data:action
*
* @author Alex Voloshyn
* @author Serge Voloshyn
* @version 1.11 3/1/15
*/
public final class IntentTokenConverter {
/**
* Delimiter for action in history token.
*/
private static final char ACTION = ':';
/**
* Delimiter for categories in history token.
*/
private static final String CATEGORY = "/";
/**
* Delimiter for data URI fragment in history token.
*/
private static final char DATA = '?';
/**
* Default home intent for welcome page.
*/
public static final Intent INTENT_HOME =
new Intent(Intent.ACTION_VIEW, Intent.CATEGORY_HOME);
/**
* Empty constructor - allows only static access to the class.
*/
private IntentTokenConverter() {
super();
}
/**
* Creates corresponding activity path for intent.
*
* @param intent to be used to create activity path
* @return resulting history token
*/
public static String toToken(final Intent intent) {
if (IntentTokenConverter.INTENT_HOME.equals(intent)) {
return "!";
}
final StringBuilder builder = new StringBuilder();
final List categories = intent.getCategories();
if (categories != null && categories.size() > 0) {
for (final String category : categories) {
builder.append(CATEGORY);
builder.append(category);
}
}
if (intent.getData() != null) {
builder.append(DATA).append(intent.getData());
}
if (intent.getAction() != null
&& !Intent.ACTION_VIEW.equals(intent.getAction())) {
builder.append(ACTION).append(intent.getAction());
}
return builder.toString();
}
}