com.liferay.source.formatter.checks.XMLTilesDefsFileCheck Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.source.formatter.checks;
import com.liferay.source.formatter.checks.comparator.ElementComparator;
import com.liferay.source.formatter.checks.util.SourceUtil;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
/**
* @author Hugo Huijser
*/
public class XMLTilesDefsFileCheck extends BaseFileCheck {
@Override
public boolean isLiferaySourceCheck() {
return true;
}
@Override
protected String doProcess(
String fileName, String absolutePath, String content)
throws DocumentException {
if (fileName.endsWith("/tiles-defs.xml")) {
_checkTilesDefsXML(fileName, content);
}
return content;
}
private void _checkTilesDefsXML(String fileName, String content)
throws DocumentException {
Document document = SourceUtil.readXML(content);
checkElementOrder(
fileName, document.getRootElement(), "definition", null,
new TilesDefinitionElementComparator());
}
private class TilesDefinitionElementComparator extends ElementComparator {
@Override
public int compare(
Element definitionElement1, Element definitionElement2) {
String definitionName1 = getElementName(definitionElement1);
if (definitionName1.equals("portlet")) {
return -1;
}
return super.compare(definitionElement1, definitionElement2);
}
}
}