com.alee.utils.XmlUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-core Show documentation
Show all versions of weblaf-core Show documentation
Core components for WebLaf
/*
* This file is part of WebLookAndFeel library.
*
* WebLookAndFeel library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WebLookAndFeel 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebLookAndFeel library. If not, see specific class type
*/
public static void alias ( final Class aliasProvider )
{
ReflectUtils.callStaticMethodSafely ( aliasProvider, AliasProvider.methodName, getXStream () );
}
/**
* Serializes Object into XML and writes it into specified file.
*
* @param obj object to serialize
* @param file output file
*/
public static void toXML ( final Object obj, final String file )
{
toXML ( obj, new File ( file ) );
}
/**
* Serializes Object into XML and writes it into specified file.
*
* @param obj object to serialize
* @param file output file
*/
public static void toXML ( final Object obj, final File file )
{
try
{
final FileOutputStream fos = new FileOutputStream ( file );
final OutputStreamWriter osw = new OutputStreamWriter ( fos, "UTF-8" );
toXML ( obj, osw );
osw.close ();
fos.close ();
}
catch ( final IOException e )
{
Log.get ().error ( TextUtils.format ( "Unable to serialize object %s into XML and write it into file: %s", obj, file ), e );
}
}
/**
* Returns Object serialized into XML.
*
* @param obj object to serialize
* @return serialized into XML object representation
*/
public static String toXML ( final Object obj )
{
return getXStream ().toXML ( obj );
}
/**
* Serializes Object into XML and writes it using a specified Writer.
*
* @param obj object to serialize
* @param out output writer
*/
public static void toXML ( final Object obj, final Writer out )
{
getXStream ().toXML ( obj, out );
}
/**
* Serializes Object into XML and writes it using a specified OutputStream.
*
* @param obj object to serialize
* @param out output stream
*/
public static void toXML ( final Object obj, final OutputStream out )
{
getXStream ().toXML ( obj, out );
}
/**
* Serializes Object into XML and writes it using a specified HierarchicalStreamWriter
*
* @param obj object to serialize
* @param writer hierarchical stream writer
*/
public static void toXML ( final Object obj, final HierarchicalStreamWriter writer )
{
getXStream ().marshal ( obj, writer );
}
/**
* Returns Object deserialized from XML content.
*
* @param reader XML text source
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final Reader reader )
{
return ( T ) getXStream ().fromXML ( reader );
}
/**
* Returns Object deserialized from XML content.
*
* @param input XML text source
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final InputStream input )
{
return ( T ) getXStream ().fromXML ( input );
}
/**
* Returns Object deserialized from XML text
*
* @param url XML text source
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final URL url )
{
return ( T ) getXStream ().fromXML ( url );
}
/**
* Returns Object deserialized from XML content.
*
* @param file file with XML content
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final File file )
{
return ( T ) getXStream ().fromXML ( file );
}
/**
* Returns Object deserialized from XML content.
*
* @param xml XML content
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final String xml )
{
return ( T ) getXStream ().fromXML ( xml );
}
/**
* Returns Object deserialized from XML content.
*
* @param source XML text source
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final Object source )
{
if ( source instanceof URL )
{
return fromXML ( ( URL ) source );
}
else if ( source instanceof String )
{
return fromXML ( new File ( ( String ) source ) );
}
else if ( source instanceof File )
{
return fromXML ( ( File ) source );
}
else if ( source instanceof Reader )
{
return fromXML ( ( Reader ) source );
}
else if ( source instanceof InputStream )
{
return fromXML ( ( InputStream ) source );
}
else
{
return null;
}
}
/**
* Returns Object deserialized from XML text
*
* @param resource XML text source description
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final ResourceFile resource )
{
return fromXML ( resource, true );
}
/**
* Returns Object deserialized from XML text
*
* @param resource XML text source description
* @param safely whether or not should try to retrieve object from XML safely without throwing any exceptions
* @param read object type
* @return deserialized object
*/
public static T fromXML ( final ResourceFile resource, final boolean safely )
{
try
{
switch ( resource.getLocation () )
{
case url:
{
return XmlUtils.fromXML ( new URL ( resource.getSource () ) );
}
case filePath:
{
return XmlUtils.fromXML ( new File ( resource.getSource () ) );
}
case nearClass:
{
// todo Replace with try-with-resource when switched to JDK8+
InputStream is = null;
try
{
is = Class.forName ( resource.getClassName () ).getResourceAsStream ( resource.getSource () );
if ( is == null )
{
final String src = resource.getSource ();
final String cn = resource.getClassName ();
throw new RuntimeException ( "Unable to read XML file \"" + src + "\" near class \"" + cn + "\"" );
}
return XmlUtils.fromXML ( is );
}
finally
{
try
{
if ( is != null )
{
is.close ();
}
}
catch ( final Throwable e )
{
// Ignore this exception
}
}
}
default:
{
return null;
}
}
}
catch ( final Throwable e )
{
if ( safely )
{
Log.get ().error ( "Unable to deserialize object from XML", e );
return null;
}
else
{
throw new RuntimeException ( "Unable to deserialize object from XML", e );
}
}
}
/**
* Returns text which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return text as String
*/
public static String loadString ( final Object source )
{
return loadString ( loadResourceFile ( source ) );
}
/**
* Returns text which is read from specified ResourceFile.
*
* @param resource file description
* @return text as String
*/
public static String loadString ( final ResourceFile resource )
{
if ( resource.getLocation ().equals ( ResourceLocation.url ) )
{
try
{
return FileUtils.readToString ( new URL ( resource.getSource () ) );
}
catch ( final IOException e )
{
Log.get ().error ( "Unable to read string from URL: " + resource.getSource (), e );
return null;
}
}
if ( resource.getLocation ().equals ( ResourceLocation.filePath ) )
{
return FileUtils.readToString ( new File ( resource.getSource () ) );
}
else if ( resource.getLocation ().equals ( ResourceLocation.nearClass ) )
{
try
{
return FileUtils.readToString ( Class.forName ( resource.getClassName () ), resource.getSource () );
}
catch ( final ClassNotFoundException e )
{
final String msg = "Unable to read string from file: %s near class: %s";
Log.get ().error ( TextUtils.format ( msg, resource.getSource (), resource.getClassName () ), e );
return null;
}
}
else
{
return null;
}
}
/**
* Returns ImageIcon which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return ImageIcon
*/
public static ImageIcon loadImageIcon ( final Object source )
{
return loadImageIcon ( loadResourceFile ( source ) );
}
/**
* Returns ImageIcon which is read from specified ResourceFile.
*
* @param resource file description
* @return ImageIcon
*/
public static ImageIcon loadImageIcon ( final ResourceFile resource )
{
if ( resource.getLocation ().equals ( ResourceLocation.url ) )
{
try
{
return new ImageIcon ( new URL ( resource.getSource () ) );
}
catch ( final MalformedURLException e )
{
Log.get ().error ( "Unable to load image from URL: " + resource.getSource (), e );
return null;
}
}
if ( resource.getLocation ().equals ( ResourceLocation.filePath ) )
{
try
{
return new ImageIcon ( new File ( resource.getSource () ).getCanonicalPath () );
}
catch ( final IOException e )
{
Log.get ().error ( "Unable to load image from file: " + resource.getSource (), e );
return null;
}
}
else if ( resource.getLocation ().equals ( ResourceLocation.nearClass ) )
{
try
{
return new ImageIcon ( Class.forName ( resource.getClassName () ).getResource ( resource.getSource () ) );
}
catch ( final ClassNotFoundException e )
{
final String msg = "Unable to load image from file: %s near class: %s";
Log.get ().error ( TextUtils.format ( msg, resource.getSource (), resource.getClassName () ), e );
return null;
}
}
else
{
return null;
}
}
/**
* Returns ImageIcon list which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return ImageIcon list
*/
public static List loadImagesList ( final Object source )
{
return loadImagesList ( loadResourceList ( source ) );
}
/**
* Returns ImageIcon list which is read from specified ResourceList.
*
* @param resourceList ResourceFile list
* @return ImageIcon list
*/
public static List loadImagesList ( final ResourceList resourceList )
{
final List icons = new ArrayList ();
for ( final ResourceFile resource : resourceList.getResources () )
{
final ImageIcon imageIcon = loadImageIcon ( resource );
if ( imageIcon != null )
{
icons.add ( imageIcon );
}
}
return icons;
}
/**
* Returns ResourceMap which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return ResourceMap
*/
public static ResourceMap loadResourceMap ( final Object source )
{
return fromXML ( source );
}
/**
* Returns ResourceList which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return ResourceList
*/
public static ResourceList loadResourceList ( final Object source )
{
return fromXML ( source );
}
/**
* Returns ResourceFile which is read from the source.
*
* @param source one of possible sources: URL, String, File, Reader, InputStream
* @return ResourceFile
*/
public static ResourceFile loadResourceFile ( final Object source )
{
return fromXML ( source );
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy